Class Job.Builder (2.43.0) 

public static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilder

Configuration for a job. The maximum allowed size for a job is 1MB.

Protobuf type google.cloud.scheduler.v1.Job

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Job.Builder

Implements

JobOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Job.Builder
Overrides

build()

public Job build()
Returns
Type Description
Job

buildPartial()

public Job buildPartial()
Returns
Type Description
Job

clear()

public Job.Builder clear()
Returns
Type Description
Job.Builder
Overrides

clearAppEngineHttpTarget()

public Job.Builder clearAppEngineHttpTarget()

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Returns
Type Description
Job.Builder

clearAttemptDeadline()

public Job.Builder clearAttemptDeadline()

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.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type Description
Job.Builder

clearDescription()

public Job.Builder clearDescription()

Optionally caller-specified in CreateJob or UpdateJob.

A human-readable description for the job. This string must not contain more than 500 characters.

string description = 2;

Returns
Type Description
Job.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Job.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Job.Builder
Overrides

clearHttpTarget()

public Job.Builder clearHttpTarget()

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Returns
Type Description
Job.Builder

clearLastAttemptTime()

public Job.Builder clearLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Job.Builder

clearName()

public Job.Builder clearName()

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.

string name = 1;

Returns
Type Description
Job.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Job.Builder
Overrides

clearPubsubTarget()

public Job.Builder clearPubsubTarget()

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Returns
Type Description
Job.Builder

clearRetryConfig()

public Job.Builder clearRetryConfig()

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Returns
Type Description
Job.Builder

clearSchedule()

public Job.Builder clearSchedule()

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.

string schedule = 20;

Returns
Type Description
Job.Builder

This builder for chaining.

clearScheduleTime()

public Job.Builder clearScheduleTime()

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.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type Description
Job.Builder

clearState()

public Job.Builder clearState()

Output only. State of the job.

.google.cloud.scheduler.v1.Job.State state = 10;

Returns
Type Description
Job.Builder

This builder for chaining.

clearStatus()

public Job.Builder clearStatus()

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

.google.rpc.Status status = 11;

Returns
Type Description
Job.Builder

clearTarget()

public Job.Builder clearTarget()
Returns
Type Description
Job.Builder

clearTimeZone()

public Job.Builder clearTimeZone()

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 time_zone = 21;

Returns
Type Description
Job.Builder

This builder for chaining.

clearUserUpdateTime()

public Job.Builder clearUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Job.Builder

clone()

public Job.Builder clone()
Returns
Type Description
Job.Builder
Overrides

getAppEngineHttpTarget()

public AppEngineHttpTarget getAppEngineHttpTarget()

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Returns
Type Description
AppEngineHttpTarget

The appEngineHttpTarget.

getAppEngineHttpTargetBuilder()

public AppEngineHttpTarget.Builder getAppEngineHttpTargetBuilder()

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Returns
Type Description
AppEngineHttpTarget.Builder

getAppEngineHttpTargetOrBuilder()

public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Returns
Type Description
AppEngineHttpTargetOrBuilder

getAttemptDeadline()

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

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type Description
Duration

The attemptDeadline.

getAttemptDeadlineBuilder()

public Duration.Builder getAttemptDeadlineBuilder()

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.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type Description
Builder

getAttemptDeadlineOrBuilder()

public DurationOrBuilder getAttemptDeadlineOrBuilder()

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.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public Job getDefaultInstanceForType()
Returns
Type Description
Job

getDescription()

public String 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 description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optionally caller-specified in CreateJob or UpdateJob.

A human-readable description for the job. This string must not contain more than 500 characters.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHttpTarget()

public HttpTarget getHttpTarget()

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Returns
Type Description
HttpTarget

The httpTarget.

getHttpTargetBuilder()

public HttpTarget.Builder getHttpTargetBuilder()

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Returns
Type Description
HttpTarget.Builder

getHttpTargetOrBuilder()

public HttpTargetOrBuilder getHttpTargetOrBuilder()

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Returns
Type Description
HttpTargetOrBuilder

getLastAttemptTime()

public Timestamp getLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Timestamp

The lastAttemptTime.

getLastAttemptTimeBuilder()

public Timestamp.Builder getLastAttemptTimeBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Builder

getLastAttemptTimeOrBuilder()

public TimestampOrBuilder getLastAttemptTimeOrBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
TimestampOrBuilder

getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPubsubTarget()

public PubsubTarget getPubsubTarget()

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Returns
Type Description
PubsubTarget

The pubsubTarget.

getPubsubTargetBuilder()

public PubsubTarget.Builder getPubsubTargetBuilder()

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Returns
Type Description
PubsubTarget.Builder

getPubsubTargetOrBuilder()

public PubsubTargetOrBuilder getPubsubTargetOrBuilder()

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Returns
Type Description
PubsubTargetOrBuilder

getRetryConfig()

public RetryConfig getRetryConfig()

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Returns
Type Description
RetryConfig

The retryConfig.

getRetryConfigBuilder()

public RetryConfig.Builder getRetryConfigBuilder()

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Returns
Type Description
RetryConfig.Builder

getRetryConfigOrBuilder()

public RetryConfigOrBuilder getRetryConfigOrBuilder()

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Returns
Type Description
RetryConfigOrBuilder

getSchedule()

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

string schedule = 20;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

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.

string schedule = 20;

Returns
Type Description
ByteString

The bytes for schedule.

getScheduleTime()

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

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeBuilder()

public Timestamp.Builder getScheduleTimeBuilder()

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.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type Description
Builder

getScheduleTimeOrBuilder()

public TimestampOrBuilder getScheduleTimeOrBuilder()

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.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type Description
TimestampOrBuilder

getState()

public Job.State getState()

Output only. State of the job.

.google.cloud.scheduler.v1.Job.State state = 10;

Returns
Type Description
Job.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the job.

.google.cloud.scheduler.v1.Job.State state = 10;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatus()

public Status getStatus()

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

.google.rpc.Status status = 11;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusBuilder()

public Status.Builder getStatusBuilder()

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

.google.rpc.Status status = 11;

Returns
Type Description
com.google.rpc.Status.Builder

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

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

.google.rpc.Status status = 11;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTargetCase()

public Job.TargetCase getTargetCase()
Returns
Type Description
Job.TargetCase

getTimeZone()

public String 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 time_zone = 21;

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

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 time_zone = 21;

Returns
Type Description
ByteString

The bytes for timeZone.

getUserUpdateTime()

public Timestamp getUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Timestamp

The userUpdateTime.

getUserUpdateTimeBuilder()

public Timestamp.Builder getUserUpdateTimeBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Builder

getUserUpdateTimeOrBuilder()

public TimestampOrBuilder getUserUpdateTimeOrBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
TimestampOrBuilder

hasAppEngineHttpTarget()

public boolean hasAppEngineHttpTarget()

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Returns
Type Description
boolean

Whether the appEngineHttpTarget field is set.

hasAttemptDeadline()

public boolean hasAttemptDeadline()

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.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type Description
boolean

Whether the attemptDeadline field is set.

hasHttpTarget()

public boolean hasHttpTarget()

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Returns
Type Description
boolean

Whether the httpTarget field is set.

hasLastAttemptTime()

public boolean hasLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
boolean

Whether the lastAttemptTime field is set.

hasPubsubTarget()

public boolean hasPubsubTarget()

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Returns
Type Description
boolean

Whether the pubsubTarget field is set.

hasRetryConfig()

public boolean hasRetryConfig()

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Returns
Type Description
boolean

Whether the retryConfig field is set.

hasScheduleTime()

public boolean hasScheduleTime()

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.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type Description
boolean

Whether the scheduleTime field is set.

hasStatus()

public boolean hasStatus()

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

.google.rpc.Status status = 11;

Returns
Type Description
boolean

Whether the status field is set.

hasUserUpdateTime()

public boolean hasUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
boolean

Whether the userUpdateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppEngineHttpTarget(AppEngineHttpTarget value)

public Job.Builder mergeAppEngineHttpTarget(AppEngineHttpTarget value)

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Parameter
Name Description
value AppEngineHttpTarget
Returns
Type Description
Job.Builder

mergeAttemptDeadline(Duration value)

public Job.Builder mergeAttemptDeadline(Duration value)

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.

.google.protobuf.Duration attempt_deadline = 22;

Parameter
Name Description
value Duration
Returns
Type Description
Job.Builder

mergeFrom(Job other)

public Job.Builder mergeFrom(Job other)
Parameter
Name Description
other Job
Returns
Type Description
Job.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Job.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Job.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Job.Builder
Overrides

mergeHttpTarget(HttpTarget value)

public Job.Builder mergeHttpTarget(HttpTarget value)

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Parameter
Name Description
value HttpTarget
Returns
Type Description
Job.Builder

mergeLastAttemptTime(Timestamp value)

public Job.Builder mergeLastAttemptTime(Timestamp value)

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

mergePubsubTarget(PubsubTarget value)

public Job.Builder mergePubsubTarget(PubsubTarget value)

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Parameter
Name Description
value PubsubTarget
Returns
Type Description
Job.Builder

mergeRetryConfig(RetryConfig value)

public Job.Builder mergeRetryConfig(RetryConfig value)

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Parameter
Name Description
value RetryConfig
Returns
Type Description
Job.Builder

mergeScheduleTime(Timestamp value)

public Job.Builder mergeScheduleTime(Timestamp value)

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.

.google.protobuf.Timestamp schedule_time = 17;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

mergeStatus(Status value)

public Job.Builder mergeStatus(Status value)

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

.google.rpc.Status status = 11;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Job.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Job.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Job.Builder
Overrides

mergeUserUpdateTime(Timestamp value)

public Job.Builder mergeUserUpdateTime(Timestamp value)

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

setAppEngineHttpTarget(AppEngineHttpTarget value)

public Job.Builder setAppEngineHttpTarget(AppEngineHttpTarget value)

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Parameter
Name Description
value AppEngineHttpTarget
Returns
Type Description
Job.Builder

setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)

public Job.Builder setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)

App Engine HTTP target.

.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;

Parameter
Name Description
builderForValue AppEngineHttpTarget.Builder
Returns
Type Description
Job.Builder

setAttemptDeadline(Duration value)

public Job.Builder setAttemptDeadline(Duration value)

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.

.google.protobuf.Duration attempt_deadline = 22;

Parameter
Name Description
value Duration
Returns
Type Description
Job.Builder

setAttemptDeadline(Duration.Builder builderForValue)

public Job.Builder setAttemptDeadline(Duration.Builder builderForValue)

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.

.google.protobuf.Duration attempt_deadline = 22;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Job.Builder

setDescription(String value)

public Job.Builder setDescription(String value)

Optionally caller-specified in CreateJob or UpdateJob.

A human-readable description for the job. This string must not contain more than 500 characters.

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Job.Builder setDescriptionBytes(ByteString value)

Optionally caller-specified in CreateJob or UpdateJob.

A human-readable description for the job. This string must not contain more than 500 characters.

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Job.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Job.Builder
Overrides

setHttpTarget(HttpTarget value)

public Job.Builder setHttpTarget(HttpTarget value)

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Parameter
Name Description
value HttpTarget
Returns
Type Description
Job.Builder

setHttpTarget(HttpTarget.Builder builderForValue)

public Job.Builder setHttpTarget(HttpTarget.Builder builderForValue)

HTTP target.

.google.cloud.scheduler.v1.HttpTarget http_target = 6;

Parameter
Name Description
builderForValue HttpTarget.Builder
Returns
Type Description
Job.Builder

setLastAttemptTime(Timestamp value)

public Job.Builder setLastAttemptTime(Timestamp value)

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

setLastAttemptTime(Timestamp.Builder builderForValue)

public Job.Builder setLastAttemptTime(Timestamp.Builder builderForValue)

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Job.Builder

setName(String value)

public Job.Builder setName(String value)

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.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Job.Builder setNameBytes(ByteString value)

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.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setPubsubTarget(PubsubTarget value)

public Job.Builder setPubsubTarget(PubsubTarget value)

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Parameter
Name Description
value PubsubTarget
Returns
Type Description
Job.Builder

setPubsubTarget(PubsubTarget.Builder builderForValue)

public Job.Builder setPubsubTarget(PubsubTarget.Builder builderForValue)

Pub/Sub target.

.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;

Parameter
Name Description
builderForValue PubsubTarget.Builder
Returns
Type Description
Job.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Job.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Job.Builder
Overrides

setRetryConfig(RetryConfig value)

public Job.Builder setRetryConfig(RetryConfig value)

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Parameter
Name Description
value RetryConfig
Returns
Type Description
Job.Builder

setRetryConfig(RetryConfig.Builder builderForValue)

public Job.Builder setRetryConfig(RetryConfig.Builder builderForValue)

Settings that determine the retry behavior.

.google.cloud.scheduler.v1.RetryConfig retry_config = 19;

Parameter
Name Description
builderForValue RetryConfig.Builder
Returns
Type Description
Job.Builder

setSchedule(String value)

public Job.Builder setSchedule(String value)

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.

string schedule = 20;

Parameter
Name Description
value String

The schedule to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setScheduleBytes(ByteString value)

public Job.Builder setScheduleBytes(ByteString value)

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.

string schedule = 20;

Parameter
Name Description
value ByteString

The bytes for schedule to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setScheduleTime(Timestamp value)

public Job.Builder setScheduleTime(Timestamp value)

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.

.google.protobuf.Timestamp schedule_time = 17;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

setScheduleTime(Timestamp.Builder builderForValue)

public Job.Builder setScheduleTime(Timestamp.Builder builderForValue)

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.

.google.protobuf.Timestamp schedule_time = 17;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Job.Builder

setState(Job.State value)

public Job.Builder setState(Job.State value)

Output only. State of the job.

.google.cloud.scheduler.v1.Job.State state = 10;

Parameter
Name Description
value Job.State

The state to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setStateValue(int value)

public Job.Builder setStateValue(int value)

Output only. State of the job.

.google.cloud.scheduler.v1.Job.State state = 10;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setStatus(Status value)

public Job.Builder setStatus(Status value)

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

.google.rpc.Status status = 11;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Job.Builder

setStatus(Status.Builder builderForValue)

public Job.Builder setStatus(Status.Builder builderForValue)

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

.google.rpc.Status status = 11;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Job.Builder

setTimeZone(String value)

public Job.Builder setTimeZone(String value)

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 time_zone = 21;

Parameter
Name Description
value String

The timeZone to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public Job.Builder setTimeZoneBytes(ByteString value)

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 time_zone = 21;

Parameter
Name Description
value ByteString

The bytes for timeZone to set.
Returns
Type Description
Job.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Job.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Job.Builder
Overrides

setUserUpdateTime(Timestamp value)

public Job.Builder setUserUpdateTime(Timestamp value)

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
Job.Builder

setUserUpdateTime(Timestamp.Builder builderForValue)

public Job.Builder setUserUpdateTime(Timestamp.Builder builderForValue)

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Job.Builder