Reference documentation and code samples for the Cloud Scheduler V1 Client class Job.
Configuration for a job.
The maximum allowed size for a job is 100KB.
Generated from protobuf message google.cloud.scheduler.v1.Job
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optionally caller-specified in CreateJob
, after which it becomes output only. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. * PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
* LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations
. For more information, see https://cloud.google.com/about/locations/
. * JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
↳ description
↳ pubsub_target
↳ app_engine_http_target
↳ http_target
↳ schedule
string
Required, except when used with UpdateJob
. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab
* English-like schedule
As a general rule, execution n + 1
of a job will not begin until execution n
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1
th execution is scheduled to run at 16:00 but the n
th execution takes until 16:15, the n+1
th execution will not start until 16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count
> 0 and a job attempt fails, the job will be tried a total of retry_count
times, with exponential backoff, until the next scheduled start time.
↳ time_zone
string
Specifies the time zone to be used in interpreting schedule . The value of this field must be a time zone name from the tz database . Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
↳ user_update_time
↳ state
int
Output only. State of the job.
↳ status
↳ schedule_time
Google\Protobuf\Timestamp
Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
↳ last_attempt_time
↳ retry_config
↳ attempt_deadline
Google\Protobuf\Duration
The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED
failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig
. The allowed duration for this deadline is: * For HTTP targets
, between 15 seconds and 30 minutes. * For App Engine HTTP targets
, between 15 seconds and 24 hours.
getName
Optionally caller-specified in CreateJob , after which it becomes output only.
The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
.
-
PROJECT_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects -
LOCATION_IDis the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations . For more information, see https://cloud.google.com/about/locations/ . -
JOB_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string
setName
Optionally caller-specified in CreateJob , after which it becomes output only.
The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
.
-
PROJECT_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects -
LOCATION_IDis the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations . For more information, see https://cloud.google.com/about/locations/ . -
JOB_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
var
string
$this
getDescription
Optionally caller-specified in CreateJob or UpdateJob .
A human-readable description for the job. This string must not contain more than 500 characters.
string
setDescription
Optionally caller-specified in CreateJob or UpdateJob .
A human-readable description for the job. This string must not contain more than 500 characters.
var
string
$this
getPubsubTarget
Pub/Sub target.
hasPubsubTarget
setPubsubTarget
Pub/Sub target.
$this
getAppEngineHttpTarget
App Engine HTTP target.
hasAppEngineHttpTarget
setAppEngineHttpTarget
App Engine HTTP target.
$this
getHttpTarget
HTTP target.
hasHttpTarget
setHttpTarget
HTTP target.
$this
getSchedule
Required, except when used with UpdateJob .
Describes the schedule on which the job will be executed. The schedule can be either of the following types:
- Crontab
- English-like schedule
As a general rule, execution
n + 1of a job will not begin until executionnhas finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1th execution is scheduled to run at 16:00 but thenth execution takes until 16:15, then+1th execution will not start until16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.
string
setSchedule
Required, except when used with UpdateJob .
Describes the schedule on which the job will be executed. The schedule can be either of the following types:
- Crontab
- English-like schedule
As a general rule, execution
n + 1of a job will not begin until executionnhas finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1th execution is scheduled to run at 16:00 but thenth execution takes until 16:15, then+1th execution will not start until16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.
var
string
$this
getTimeZone
Specifies the time zone to be used in interpreting schedule . The value of this field must be a time zone name from the tz database .
Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
string
setTimeZone
Specifies the time zone to be used in interpreting schedule . The value of this field must be a time zone name from the tz database .
Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
var
string
$this
getUserUpdateTime
Output only. The creation time of the job.
hasUserUpdateTime
clearUserUpdateTime
setUserUpdateTime
Output only. The creation time of the job.
$this
getState
Output only. State of the job.
int
setState
Output only. State of the job.
var
int
$this
getStatus
Output only. The response from the target for the last attempted execution.
hasStatus
clearStatus
setStatus
Output only. The response from the target for the last attempted execution.
$this
getScheduleTime
Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
hasScheduleTime
clearScheduleTime
setScheduleTime
Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
$this
getLastAttemptTime
Output only. The time the last job attempt started.
hasLastAttemptTime
clearLastAttemptTime
setLastAttemptTime
Output only. The time the last job attempt started.
$this
getRetryConfig
Settings that determine the retry behavior.
hasRetryConfig
clearRetryConfig
setRetryConfig
Settings that determine the retry behavior.
$this
getAttemptDeadline
The deadline for job attempts. If the request handler does not respond by
this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED
failure. The failed attempt can be viewed in
execution logs. Cloud Scheduler will retry the job according
to the RetryConfig
.
The allowed duration for this deadline is:
- For HTTP targets , between 15 seconds and 30 minutes.
- For App Engine HTTP targets , between 15 seconds and 24 hours.
hasAttemptDeadline
clearAttemptDeadline
setAttemptDeadline
The deadline for job attempts. If the request handler does not respond by
this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED
failure. The failed attempt can be viewed in
execution logs. Cloud Scheduler will retry the job according
to the RetryConfig
.
The allowed duration for this deadline is:
- For HTTP targets , between 15 seconds and 30 minutes.
- For App Engine HTTP targets , between 15 seconds and 24 hours.
$this
getTarget
string
