Class Job.Builder (2.19.0)

publicstaticfinalclass Job.BuilderextendsGeneratedMessageV3.Builder<Job.Builder>implementsJobOrBuilder

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

Protobuf type google.cloud.scheduler.v1beta1.Job

Implements

JobOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicJob.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Job.Builder
Overrides

build()

publicJobbuild()
Returns
Type Description
Job

buildPartial()

publicJobbuildPartial()
Returns
Type Description
Job

clear()

publicJob.Builderclear()
Returns
Type Description
Job.Builder
Overrides

clearAppEngineHttpTarget()

publicJob.BuilderclearAppEngineHttpTarget()

App Engine HTTP target.

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

Returns
Type Description
Job.Builder

clearAttemptDeadline()

publicJob.BuilderclearAttemptDeadline()

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

publicJob.BuilderclearDescription()

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)

publicJob.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Job.Builder
Overrides

clearHttpTarget()

publicJob.BuilderclearHttpTarget()

HTTP target.

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

Returns
Type Description
Job.Builder

clearLastAttemptTime()

publicJob.BuilderclearLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Job.Builder

clearLegacyAppEngineCron()

publicJob.BuilderclearLegacyAppEngineCron()

Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.

bool legacy_app_engine_cron = 23 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Job.Builder

This builder for chaining.

clearName()

publicJob.BuilderclearName()

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)

publicJob.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Job.Builder
Overrides

clearPubsubTarget()

publicJob.BuilderclearPubsubTarget()

Pub/Sub target.

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

Returns
Type Description
Job.Builder

clearRetryConfig()

publicJob.BuilderclearRetryConfig()

Settings that determine the retry behavior.

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

Returns
Type Description
Job.Builder

clearSchedule()

publicJob.BuilderclearSchedule()

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

publicJob.BuilderclearScheduleTime()

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

publicJob.BuilderclearState()

Output only. State of the job.

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

Returns
Type Description
Job.Builder

This builder for chaining.

clearStatus()

publicJob.BuilderclearStatus()

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

.google.rpc.Status status = 11;

Returns
Type Description
Job.Builder

clearTarget()

publicJob.BuilderclearTarget()
Returns
Type Description
Job.Builder

clearTimeZone()

publicJob.BuilderclearTimeZone()

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

publicJob.BuilderclearUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Job.Builder

clone()

publicJob.Builderclone()
Returns
Type Description
Job.Builder
Overrides

getAppEngineHttpTarget()

publicAppEngineHttpTargetgetAppEngineHttpTarget()

App Engine HTTP target.

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

Returns
Type Description
AppEngineHttpTarget

The appEngineHttpTarget.

getAppEngineHttpTargetBuilder()

publicAppEngineHttpTarget.BuildergetAppEngineHttpTargetBuilder()

App Engine HTTP target.

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

Returns
Type Description
AppEngineHttpTarget.Builder

getAppEngineHttpTargetOrBuilder()

publicAppEngineHttpTargetOrBuildergetAppEngineHttpTargetOrBuilder()

App Engine HTTP target.

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

Returns
Type Description
AppEngineHttpTargetOrBuilder

getAttemptDeadline()

publicDurationgetAttemptDeadline()

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

publicDuration.BuildergetAttemptDeadlineBuilder()

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

publicDurationOrBuildergetAttemptDeadlineOrBuilder()

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

publicJobgetDefaultInstanceForType()
Returns
Type Description
Job

getDescription()

publicStringgetDescription()

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

publicByteStringgetDescriptionBytes()

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

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHttpTarget()

publicHttpTargetgetHttpTarget()

HTTP target.

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

Returns
Type Description
HttpTarget

The httpTarget.

getHttpTargetBuilder()

publicHttpTarget.BuildergetHttpTargetBuilder()

HTTP target.

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

Returns
Type Description
HttpTarget.Builder

getHttpTargetOrBuilder()

publicHttpTargetOrBuildergetHttpTargetOrBuilder()

HTTP target.

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

Returns
Type Description
HttpTargetOrBuilder

getLastAttemptTime()

publicTimestampgetLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Timestamp

The lastAttemptTime.

getLastAttemptTimeBuilder()

publicTimestamp.BuildergetLastAttemptTimeBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
Builder

getLastAttemptTimeOrBuilder()

publicTimestampOrBuildergetLastAttemptTimeOrBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type Description
TimestampOrBuilder

getLegacyAppEngineCron()

publicbooleangetLegacyAppEngineCron()

Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.

bool legacy_app_engine_cron = 23 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

The legacyAppEngineCron.

getName()

publicStringgetName()

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

publicByteStringgetNameBytes()

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

publicPubsubTargetgetPubsubTarget()

Pub/Sub target.

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

Returns
Type Description
PubsubTarget

The pubsubTarget.

getPubsubTargetBuilder()

publicPubsubTarget.BuildergetPubsubTargetBuilder()

Pub/Sub target.

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

Returns
Type Description
PubsubTarget.Builder

getPubsubTargetOrBuilder()

publicPubsubTargetOrBuildergetPubsubTargetOrBuilder()

Pub/Sub target.

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

Returns
Type Description
PubsubTargetOrBuilder

getRetryConfig()

publicRetryConfiggetRetryConfig()

Settings that determine the retry behavior.

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

Returns
Type Description
RetryConfig

The retryConfig.

getRetryConfigBuilder()

publicRetryConfig.BuildergetRetryConfigBuilder()

Settings that determine the retry behavior.

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

Returns
Type Description
RetryConfig.Builder

getRetryConfigOrBuilder()

publicRetryConfigOrBuildergetRetryConfigOrBuilder()

Settings that determine the retry behavior.

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

Returns
Type Description
RetryConfigOrBuilder

getSchedule()

publicStringgetSchedule()

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

publicByteStringgetScheduleBytes()

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

publicTimestampgetScheduleTime()

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

publicTimestamp.BuildergetScheduleTimeBuilder()

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

publicTimestampOrBuildergetScheduleTimeOrBuilder()

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

publicJob.StategetState()

Output only. State of the job.

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

Returns
Type Description
Job.State

The state.

getStateValue()

publicintgetStateValue()

Output only. State of the job.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatus()

publicStatusgetStatus()

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

publicStatus.BuildergetStatusBuilder()

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

publicStatusOrBuildergetStatusOrBuilder()

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

publicJob.TargetCasegetTargetCase()
Returns
Type Description
Job.TargetCase

getTimeZone()

publicStringgetTimeZone()

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

publicByteStringgetTimeZoneBytes()

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

publicTimestampgetUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Timestamp

The userUpdateTime.

getUserUpdateTimeBuilder()

publicTimestamp.BuildergetUserUpdateTimeBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
Builder

getUserUpdateTimeOrBuilder()

publicTimestampOrBuildergetUserUpdateTimeOrBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type Description
TimestampOrBuilder

hasAppEngineHttpTarget()

publicbooleanhasAppEngineHttpTarget()

App Engine HTTP target.

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

Returns
Type Description
boolean

Whether the appEngineHttpTarget field is set.

hasAttemptDeadline()

publicbooleanhasAttemptDeadline()

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

publicbooleanhasHttpTarget()

HTTP target.

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

Returns
Type Description
boolean

Whether the httpTarget field is set.

hasLastAttemptTime()

publicbooleanhasLastAttemptTime()

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

publicbooleanhasPubsubTarget()

Pub/Sub target.

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

Returns
Type Description
boolean

Whether the pubsubTarget field is set.

hasRetryConfig()

publicbooleanhasRetryConfig()

Settings that determine the retry behavior.

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

Returns
Type Description
boolean

Whether the retryConfig field is set.

hasScheduleTime()

publicbooleanhasScheduleTime()

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

publicbooleanhasStatus()

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

publicbooleanhasUserUpdateTime()

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

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeAppEngineHttpTarget(AppEngineHttpTarget value)

publicJob.BuildermergeAppEngineHttpTarget(AppEngineHttpTargetvalue)

App Engine HTTP target.

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

Parameter
Name Description
value AppEngineHttpTarget
Returns
Type Description
Job.Builder

mergeAttemptDeadline(Duration value)

publicJob.BuildermergeAttemptDeadline(Durationvalue)

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)

publicJob.BuildermergeFrom(Jobother)
Parameter
Name Description
other Job
Returns
Type Description
Job.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicJob.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicJob.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Job.Builder
Overrides

mergeHttpTarget(HttpTarget value)

publicJob.BuildermergeHttpTarget(HttpTargetvalue)

HTTP target.

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

Parameter
Name Description
value HttpTarget
Returns
Type Description
Job.Builder

mergeLastAttemptTime(Timestamp value)

publicJob.BuildermergeLastAttemptTime(Timestampvalue)

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)

publicJob.BuildermergePubsubTarget(PubsubTargetvalue)

Pub/Sub target.

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

Parameter
Name Description
value PubsubTarget
Returns
Type Description
Job.Builder

mergeRetryConfig(RetryConfig value)

publicJob.BuildermergeRetryConfig(RetryConfigvalue)

Settings that determine the retry behavior.

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

Parameter
Name Description
value RetryConfig
Returns
Type Description
Job.Builder

mergeScheduleTime(Timestamp value)

publicJob.BuildermergeScheduleTime(Timestampvalue)

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)

publicJob.BuildermergeStatus(Statusvalue)

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)

publicfinalJob.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Job.Builder
Overrides

mergeUserUpdateTime(Timestamp value)

publicJob.BuildermergeUserUpdateTime(Timestampvalue)

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)

publicJob.BuildersetAppEngineHttpTarget(AppEngineHttpTargetvalue)

App Engine HTTP target.

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

Parameter
Name Description
value AppEngineHttpTarget
Returns
Type Description
Job.Builder

setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)

publicJob.BuildersetAppEngineHttpTarget(AppEngineHttpTarget.BuilderbuilderForValue)

App Engine HTTP target.

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

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

setAttemptDeadline(Duration value)

publicJob.BuildersetAttemptDeadline(Durationvalue)

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)

publicJob.BuildersetAttemptDeadline(Duration.BuilderbuilderForValue)

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)

publicJob.BuildersetDescription(Stringvalue)

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)

publicJob.BuildersetDescriptionBytes(ByteStringvalue)

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)

publicJob.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Job.Builder
Overrides

setHttpTarget(HttpTarget value)

publicJob.BuildersetHttpTarget(HttpTargetvalue)

HTTP target.

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

Parameter
Name Description
value HttpTarget
Returns
Type Description
Job.Builder

setHttpTarget(HttpTarget.Builder builderForValue)

publicJob.BuildersetHttpTarget(HttpTarget.BuilderbuilderForValue)

HTTP target.

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

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

setLastAttemptTime(Timestamp value)

publicJob.BuildersetLastAttemptTime(Timestampvalue)

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)

publicJob.BuildersetLastAttemptTime(Timestamp.BuilderbuilderForValue)

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

setLegacyAppEngineCron(boolean value)

publicJob.BuildersetLegacyAppEngineCron(booleanvalue)

Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.

bool legacy_app_engine_cron = 23 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value boolean

The legacyAppEngineCron to set.

Returns
Type Description
Job.Builder

This builder for chaining.

setName(String value)

publicJob.BuildersetName(Stringvalue)

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)

publicJob.BuildersetNameBytes(ByteStringvalue)

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)

publicJob.BuildersetPubsubTarget(PubsubTargetvalue)

Pub/Sub target.

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

Parameter
Name Description
value PubsubTarget
Returns
Type Description
Job.Builder

setPubsubTarget(PubsubTarget.Builder builderForValue)

publicJob.BuildersetPubsubTarget(PubsubTarget.BuilderbuilderForValue)

Pub/Sub target.

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

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

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

publicJob.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Job.Builder
Overrides

setRetryConfig(RetryConfig value)

publicJob.BuildersetRetryConfig(RetryConfigvalue)

Settings that determine the retry behavior.

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

Parameter
Name Description
value RetryConfig
Returns
Type Description
Job.Builder

setRetryConfig(RetryConfig.Builder builderForValue)

publicJob.BuildersetRetryConfig(RetryConfig.BuilderbuilderForValue)

Settings that determine the retry behavior.

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

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

setSchedule(String value)

publicJob.BuildersetSchedule(Stringvalue)

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)

publicJob.BuildersetScheduleBytes(ByteStringvalue)

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)

publicJob.BuildersetScheduleTime(Timestampvalue)

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)

publicJob.BuildersetScheduleTime(Timestamp.BuilderbuilderForValue)

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)

publicJob.BuildersetState(Job.Statevalue)

Output only. State of the job.

.google.cloud.scheduler.v1beta1.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)

publicJob.BuildersetStateValue(intvalue)

Output only. State of the job.

.google.cloud.scheduler.v1beta1.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)

publicJob.BuildersetStatus(Statusvalue)

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)

publicJob.BuildersetStatus(Status.BuilderbuilderForValue)

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)

publicJob.BuildersetTimeZone(Stringvalue)

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)

publicJob.BuildersetTimeZoneBytes(ByteStringvalue)

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)

publicfinalJob.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Job.Builder
Overrides

setUserUpdateTime(Timestamp value)

publicJob.BuildersetUserUpdateTime(Timestampvalue)

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)

publicJob.BuildersetUserUpdateTime(Timestamp.BuilderbuilderForValue)

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.