Cloud Scheduler V1 Client - Class Job (2.0.0)

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 1MB.

Generated from protobuf message google.cloud.scheduler.v1.Job

Namespace

Google \ Cloud \ Scheduler \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 string

Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
↳ pubsub_target Google\Cloud\Scheduler\V1\PubsubTarget

Pub/Sub target.
↳ app_engine_http_target Google\Cloud\Scheduler\V1\AppEngineHttpTarget

App Engine HTTP target.
↳ http_target Google\Cloud\Scheduler\V1\HttpTarget

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+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th 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 Google\Protobuf\Timestamp

Output only. The creation time of the job.
↳ state int

Output only. State of the job.
↳ status Google\Rpc\Status

Output only. The response from the target for the last attempted execution.
↳ 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 Google\Protobuf\Timestamp

Output only. The time the last job attempt started.
↳ retry_config Google\Cloud\Scheduler\V1\RetryConfig

Settings that determine the retry behavior.
↳ 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored.

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_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.
Returns
Type Description
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_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.
Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getPubsubTarget

Pub/Sub target.

Returns
Type Description
Google\Cloud\Scheduler\V1\PubsubTarget|null

hasPubsubTarget

setPubsubTarget

Pub/Sub target.

Parameter
Name Description
var Google\Cloud\Scheduler\V1\PubsubTarget
Returns
Type Description
$this

getAppEngineHttpTarget

App Engine HTTP target.

Returns
Type Description
Google\Cloud\Scheduler\V1\AppEngineHttpTarget|null

hasAppEngineHttpTarget

setAppEngineHttpTarget

App Engine HTTP target.

Parameter
Name Description
var Google\Cloud\Scheduler\V1\AppEngineHttpTarget
Returns
Type Description
$this

getHttpTarget

HTTP target.

Returns
Type Description
Google\Cloud\Scheduler\V1\HttpTarget|null

hasHttpTarget

setHttpTarget

HTTP target.

Parameter
Name Description
var Google\Cloud\Scheduler\V1\HttpTarget
Returns
Type Description
$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 + 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+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th 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.
Returns
Type Description
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 + 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+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th 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.
Parameter
Name Description
var string
Returns
Type Description
$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).

Returns
Type Description
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).

Parameter
Name Description
var string
Returns
Type Description
$this

getUserUpdateTime

Output only. The creation time of the job.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUserUpdateTime

clearUserUpdateTime

setUserUpdateTime

Output only. The creation time of the job.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. State of the job.

Returns
Type Description
int

setState

Output only. State of the job.

Parameter
Name Description
var int
Returns
Type Description
$this

getStatus

Output only. The response from the target for the last attempted execution.

Returns
Type Description
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

Output only. The response from the target for the last attempted execution.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastAttemptTime

Output only. The time the last job attempt started.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastAttemptTime

clearLastAttemptTime

setLastAttemptTime

Output only. The time the last job attempt started.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRetryConfig

Settings that determine the retry behavior.

Returns
Type Description
Google\Cloud\Scheduler\V1\RetryConfig|null

hasRetryConfig

clearRetryConfig

setRetryConfig

Settings that determine the retry behavior.

Parameter
Name Description
var Google\Cloud\Scheduler\V1\RetryConfig
Returns
Type Description
$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 default and the allowed values depend on the type of target:

  • For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].
  • For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds].
  • For Pub/Sub targets, this field is ignored.
Returns
Type Description
Google\Protobuf\Duration|null

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 default and the allowed values depend on the type of target:

  • For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].
  • For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds].
  • For Pub/Sub targets, this field is ignored.
Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getTarget

Returns
Type Description
string