public final class Job extends GeneratedMessageV3 implements JobOrBuilder
Configuration for a job.
The maximum allowed size for a job is 1MB.
Protobuf type google.cloud.scheduler.v1beta1.Job
Static Fields
APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
ATTEMPT_DEADLINE_FIELD_NUMBER
public static final int ATTEMPT_DEADLINE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
HTTP_TARGET_FIELD_NUMBER
public static final int HTTP_TARGET_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
LAST_ATTEMPT_TIME_FIELD_NUMBER
public static final int LAST_ATTEMPT_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
LEGACY_APP_ENGINE_CRON_FIELD_NUMBER
public static final int LEGACY_APP_ENGINE_CRON_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
PUBSUB_TARGET_FIELD_NUMBER
public static final int PUBSUB_TARGET_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
RETRY_CONFIG_FIELD_NUMBER
public static final int RETRY_CONFIG_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
SCHEDULE_TIME_FIELD_NUMBER
public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
USER_UPDATE_TIME_FIELD_NUMBER
public static final int USER_UPDATE_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
Returns |
---|
Type | Description |
Job | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Job.Builder newBuilder()
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
Parameter |
---|
Name | Description |
prototype | Job
|
public static Job parseDelimitedFrom(InputStream input)
Returns |
---|
Type | Description |
Job | |
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
Returns |
---|
Type | Description |
Job | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
Returns |
---|
Type | Description |
Job | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
public static Job parseFrom(CodedInputStream input)
Returns |
---|
Type | Description |
Job | |
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
public static Job parseFrom(InputStream input)
Returns |
---|
Type | Description |
Job | |
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
Returns |
---|
Type | Description |
Job | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Returns |
---|
Type | Description |
Job | |
parser()
public static Parser<Job> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
getAppEngineHttpTarget()
public AppEngineHttpTarget getAppEngineHttpTarget()
App Engine HTTP target.
.google.cloud.scheduler.v1beta1.AppEngineHttpTarget app_engine_http_target = 5;
getAppEngineHttpTargetOrBuilder()
public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()
App Engine HTTP target.
.google.cloud.scheduler.v1beta1.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 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.
|
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;
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.
|
getHttpTarget()
public HttpTarget getHttpTarget()
HTTP target.
.google.cloud.scheduler.v1beta1.HttpTarget http_target = 6;
getHttpTargetOrBuilder()
public HttpTargetOrBuilder getHttpTargetOrBuilder()
HTTP target.
.google.cloud.scheduler.v1beta1.HttpTarget http_target = 6;
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.
|
getLastAttemptTimeOrBuilder()
public TimestampOrBuilder getLastAttemptTimeOrBuilder()
Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
getLegacyAppEngineCron()
public boolean getLegacyAppEngineCron()
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()
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.
|
getParserForType()
public Parser<Job> getParserForType()
Overrides
getPubsubTarget()
public PubsubTarget getPubsubTarget()
Pub/Sub target.
.google.cloud.scheduler.v1beta1.PubsubTarget pubsub_target = 4;
getPubsubTargetOrBuilder()
public PubsubTargetOrBuilder getPubsubTargetOrBuilder()
Pub/Sub target.
.google.cloud.scheduler.v1beta1.PubsubTarget pubsub_target = 4;
getRetryConfig()
public RetryConfig getRetryConfig()
Settings that determine the retry behavior.
.google.cloud.scheduler.v1beta1.RetryConfig retry_config = 19;
getRetryConfigOrBuilder()
public RetryConfigOrBuilder getRetryConfigOrBuilder()
Settings that determine the retry behavior.
.google.cloud.scheduler.v1beta1.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+1
th execution is scheduled to run at
16:00 but the n
th execution takes until 16:15, the n+1
th
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+1
th execution is scheduled to run at
16:00 but the n
th execution takes until 16:15, the n+1
th
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.
|
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 |
---|
Type | Description |
int | |
Overrides
getState()
public Job.State getState()
Output only. State of the job.
.google.cloud.scheduler.v1beta1.Job.State state = 10;
getStateValue()
public int getStateValue()
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()
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.
|
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()
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.
|
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Job.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides