Cloud Scheduler V1 Client - Class Job (1.6.8)

Version 1.6.8

• 2.0.1 (latest)
• 2.0.0
• 1.10.5
• 1.9.4
• 1.8.3
• 1.7.1
• 1.6.8

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.

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 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_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.

Generated from protobuf field string name = 1;

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.

Generated from protobuf field string name = 1;

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.

Generated from protobuf field string description = 2;

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.

Generated from protobuf field string description = 2;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPubsubTarget

Pub/Sub target.

Generated from protobuf field .google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

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

hasPubsubTarget

setPubsubTarget

Pub/Sub target.

Generated from protobuf field .google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Parameter
Name	Description
var	Google\Cloud\Scheduler\V1\PubsubTarget

Returns
Type	Description
$this

getAppEngineHttpTarget

App Engine HTTP target.

Generated from protobuf field .google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

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

hasAppEngineHttpTarget

setAppEngineHttpTarget

App Engine HTTP target.

Generated from protobuf field .google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Parameter
Name	Description
var	Google\Cloud\Scheduler\V1\AppEngineHttpTarget

Returns
Type	Description
$this

getHttpTarget

HTTP target.

Generated from protobuf field .google.cloud.scheduler.v1.HttpTarget http_target = 6;

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

hasHttpTarget

setHttpTarget

HTTP target.

Generated from protobuf field .google.cloud.scheduler.v1.HttpTarget http_target = 6;

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.

Generated from protobuf field string schedule = 20;

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.

Generated from protobuf field string schedule = 20;

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).

Generated from protobuf field string time_zone = 21;

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).

Generated from protobuf field string time_zone = 21;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUserUpdateTime

Output only. The creation time of the job.

Generated from protobuf field .google.protobuf.Timestamp user_update_time = 9;

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUserUpdateTime

clearUserUpdateTime

setUserUpdateTime

Output only. The creation time of the job.

Generated from protobuf field .google.protobuf.Timestamp user_update_time = 9;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getState

Output only. State of the job.

Generated from protobuf field .google.cloud.scheduler.v1.Job.State state = 10;

Returns
Type	Description
int

setState

Output only. State of the job.

Generated from protobuf field .google.cloud.scheduler.v1.Job.State state = 10;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStatus

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

Generated from protobuf field .google.rpc.Status status = 11;

Returns
Type	Description
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

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

Generated from protobuf field .google.rpc.Status status = 11;

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.

Generated from protobuf field .google.protobuf.Timestamp schedule_time = 17;

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.

Generated from protobuf field .google.protobuf.Timestamp schedule_time = 17;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLastAttemptTime

Output only. The time the last job attempt started.

Generated from protobuf field .google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasLastAttemptTime

clearLastAttemptTime

setLastAttemptTime

Output only. The time the last job attempt started.

Generated from protobuf field .google.protobuf.Timestamp last_attempt_time = 18;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getRetryConfig

Settings that determine the retry behavior.

Generated from protobuf field .google.cloud.scheduler.v1.RetryConfig retry_config = 19;

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

hasRetryConfig

clearRetryConfig

setRetryConfig

Settings that determine the retry behavior.

Generated from protobuf field .google.cloud.scheduler.v1.RetryConfig retry_config = 19;

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

Generated from protobuf field .google.protobuf.Duration attempt_deadline = 22;

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

Generated from protobuf field .google.protobuf.Duration attempt_deadline = 22;

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getTarget

Returns
Type	Description
string