public final class Job extends GeneratedMessageV3 implements JobOrBuilder
Configuration for a job.
The maximum allowed size for a job is 100KB.
Protobuf type google.cloud.scheduler.v1.Job
Static Fields
APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
Field Value
ATTEMPT_DEADLINE_FIELD_NUMBER
public static final int ATTEMPT_DEADLINE_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
HTTP_TARGET_FIELD_NUMBER
public static final int HTTP_TARGET_FIELD_NUMBER
Field Value
LAST_ATTEMPT_TIME_FIELD_NUMBER
public static final int LAST_ATTEMPT_TIME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PUBSUB_TARGET_FIELD_NUMBER
public static final int PUBSUB_TARGET_FIELD_NUMBER
Field Value
RETRY_CONFIG_FIELD_NUMBER
public static final int RETRY_CONFIG_FIELD_NUMBER
Field Value
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value
SCHEDULE_TIME_FIELD_NUMBER
public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value
USER_UPDATE_TIME_FIELD_NUMBER
public static final int USER_UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Job.Builder newBuilder()
Returns
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
Parameter
| Name | Description |
| prototype | Job
|
Returns
public static Job parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Job parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Job parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Job> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAppEngineHttpTarget()
public AppEngineHttpTarget getAppEngineHttpTarget()
App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
getAppEngineHttpTargetOrBuilder()
public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()
App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
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 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.
.google.protobuf.Duration attempt_deadline = 22;
| Type | Description |
| Duration | The attemptDeadline.
|
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 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.
.google.protobuf.Duration attempt_deadline = 22;
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
Returns
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;
| 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;
| Type | Description |
| ByteString | The bytes for description.
|
getHttpTarget()
public HttpTarget getHttpTarget()
HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
getHttpTargetOrBuilder()
public HttpTargetOrBuilder getHttpTargetOrBuilder()
HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
getLastAttemptTime()
public Timestamp getLastAttemptTime()
Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
getLastAttemptTimeOrBuilder()
public TimestampOrBuilder getLastAttemptTimeOrBuilder()
Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
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
projectsLOCATION_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;
| 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
projectsLOCATION_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;
getParserForType()
public Parser<Job> getParserForType()
Returns
Overrides
getPubsubTarget()
public PubsubTarget getPubsubTarget()
Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
getPubsubTargetOrBuilder()
public PubsubTargetOrBuilder getPubsubTargetOrBuilder()
Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
getRetryConfig()
public RetryConfig getRetryConfig()
Settings that determine the retry behavior.
.google.cloud.scheduler.v1.RetryConfig retry_config = 19;
getRetryConfigOrBuilder()
public RetryConfigOrBuilder getRetryConfigOrBuilder()
Settings that determine the retry behavior.
.google.cloud.scheduler.v1.RetryConfig retry_config = 19;
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;
| 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;
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public Job.State getState()
Output only. State of the job.
.google.cloud.scheduler.v1.Job.State state = 10;
getStateValue()
public int getStateValue()
Output only. State of the job.
.google.cloud.scheduler.v1.Job.State state = 10;
| 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;
| Type | Description |
| com.google.rpc.Status | The status.
|
getStatusOrBuilder()
public StatusOrBuilder getStatusOrBuilder()
Output only. The response from the target for the last attempted execution.
.google.rpc.Status status = 11;
| Type | Description |
| com.google.rpc.StatusOrBuilder | |
getTargetCase()
public Job.TargetCase getTargetCase()
Returns
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;
| 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUserUpdateTime()
public Timestamp getUserUpdateTime()
Output only. The creation time of the job.
.google.protobuf.Timestamp user_update_time = 9;
getUserUpdateTimeOrBuilder()
public TimestampOrBuilder getUserUpdateTimeOrBuilder()
Output only. The creation time of the job.
.google.protobuf.Timestamp user_update_time = 9;
hasAppEngineHttpTarget()
public boolean hasAppEngineHttpTarget()
App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
| 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 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.
.google.protobuf.Duration attempt_deadline = 22;
| Type | Description |
| boolean | Whether the attemptDeadline field is set.
|
hasHttpTarget()
public boolean hasHttpTarget()
HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
| 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;
| Type | Description |
| boolean | Whether the lastAttemptTime field is set.
|
hasPubsubTarget()
public boolean hasPubsubTarget()
Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the userUpdateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Job.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
