Class Job (2.6.0)

publicfinalclass JobextendsGeneratedMessageV3implementsJobOrBuilder

Configuration for a job. The maximum allowed size for a job is 100KB.

Protobuf type google.cloud.scheduler.v1beta1.Job

Inheritance

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

Implements

JobOrBuilder

Inherited Members

publicstaticfinalintAPP_ENGINE_HTTP_TARGET_FIELD_NUMBER

publicstaticfinalintATTEMPT_DEADLINE_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER

publicstaticfinalintHTTP_TARGET_FIELD_NUMBER

publicstaticfinalintLAST_ATTEMPT_TIME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintPUBSUB_TARGET_FIELD_NUMBER

publicstaticfinalintRETRY_CONFIG_FIELD_NUMBER

publicstaticfinalintSCHEDULE_FIELD_NUMBER

publicstaticfinalintSCHEDULE_TIME_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER

publicstaticfinalintSTATUS_FIELD_NUMBER

publicstaticfinalintTIME_ZONE_FIELD_NUMBER

publicstaticfinalintUSER_UPDATE_TIME_FIELD_NUMBER

publicstaticJobgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticJob.BuildernewBuilder()

publicstaticJob.BuildernewBuilder(Jobprototype)

publicstaticJobparseDelimitedFrom(InputStreaminput)

publicstaticJobparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticJobparseFrom(byte[]data)

publicstaticJobparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticJobparseFrom(ByteStringdata)

publicstaticJobparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticJobparseFrom(CodedInputStreaminput)

publicstaticJobparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticJobparseFrom(InputStreaminput)

publicstaticJobparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticJobparseFrom(ByteBufferdata)

publicstaticJobparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Job>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicAppEngineHttpTargetgetAppEngineHttpTarget()

App Engine HTTP target.

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

publicAppEngineHttpTargetOrBuildergetAppEngineHttpTargetOrBuilder()

App Engine HTTP target.

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

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 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.
• For PubSub targets, this field is ignored.

.google.protobuf.Duration attempt_deadline = 22;

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 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.
• For PubSub targets, this field is ignored.

.google.protobuf.Duration attempt_deadline = 22;

publicJobgetDefaultInstanceForType()

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;

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;

publicHttpTargetgetHttpTarget()

HTTP target.

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

publicHttpTargetOrBuildergetHttpTargetOrBuilder()

HTTP target.

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

publicTimestampgetLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

publicTimestampOrBuildergetLastAttemptTimeOrBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

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;

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;

publicParser<Job>getParserForType()

GeneratedMessageV3.getParserForType()

publicPubsubTargetgetPubsubTarget()

Pub/Sub target.

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

publicPubsubTargetOrBuildergetPubsubTargetOrBuilder()

Pub/Sub target.

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

publicRetryConfiggetRetryConfig()

Settings that determine the retry behavior.

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

publicRetryConfigOrBuildergetRetryConfigOrBuilder()

Settings that determine the retry behavior.

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

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;

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;

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;

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;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicJob.StategetState()

Output only. State of the job.

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

publicintgetStateValue()

Output only. State of the job.

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

publicStatusgetStatus()

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

.google.rpc.Status status = 11;

publicStatusOrBuildergetStatusOrBuilder()

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

.google.rpc.Status status = 11;

publicJob.TargetCasegetTargetCase()

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;

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;

publicfinalUnknownFieldSetgetUnknownFields()

GeneratedMessageV3.getUnknownFields()

publicTimestampgetUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

publicTimestampOrBuildergetUserUpdateTimeOrBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

publicbooleanhasAppEngineHttpTarget()

App Engine HTTP target.

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

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 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.
• For PubSub targets, this field is ignored.

.google.protobuf.Duration attempt_deadline = 22;

publicbooleanhasHttpTarget()

HTTP target.

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

publicbooleanhasLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

publicbooleanhasPubsubTarget()

Pub/Sub target.

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

publicbooleanhasRetryConfig()

Settings that determine the retry behavior.

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

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;

publicbooleanhasStatus()

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

.google.rpc.Status status = 11;

publicbooleanhasUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicJob.BuildernewBuilderForType()

protectedJob.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicJob.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)