Class Job (2.19.0)

Version 2.19.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.13
• 2.2.0
• 2.1.23

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

Inheritance

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

Implements

JobOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Returns
Type	Description
Descriptor

newBuilder()

public static Job.Builder newBuilder()

Returns
Type	Description
Job.Builder

newBuilder(Job prototype)

public static Job.Builder newBuilder(Job prototype)

Parameter
Name	Description
prototype	Job

Returns
Type	Description
Job.Builder

parseDelimitedFrom(InputStream input)

public static Job parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Job parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Job parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Job parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Job parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Job parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Job

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Job> parser()

Returns
Type	Description
Parser<Job>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAppEngineHttpTarget()

public AppEngineHttpTarget getAppEngineHttpTarget()

App Engine HTTP target.

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

Returns
Type	Description
AppEngineHttpTarget	The appEngineHttpTarget.

getAppEngineHttpTargetOrBuilder()

public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()

App Engine HTTP target.

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

Returns
Type	Description
AppEngineHttpTargetOrBuilder

getAttemptDeadline()

public Duration getAttemptDeadline()

The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig.

The default and the allowed values depend on the type of target:

• For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

• For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds].

• For Pub/Sub targets, this field is ignored.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type	Description
Duration	The attemptDeadline.

getAttemptDeadlineOrBuilder()

public DurationOrBuilder getAttemptDeadlineOrBuilder()

The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig.

The default and the allowed values depend on the type of target:

• For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

• For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds].

• For Pub/Sub targets, this field is ignored.

.google.protobuf.Duration attempt_deadline = 22;

Returns
Type	Description
DurationOrBuilder

getDefaultInstanceForType()

public Job getDefaultInstanceForType()

Returns
Type	Description
Job

getDescription()

public String getDescription()

Optionally caller-specified in CreateJob or UpdateJob.

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

string description = 2;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optionally caller-specified in CreateJob or UpdateJob.

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

string description = 2;

Returns
Type	Description
ByteString	The bytes for description.

getHttpTarget()

public HttpTarget getHttpTarget()

HTTP target.

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

Returns
Type	Description
HttpTarget	The httpTarget.

getHttpTargetOrBuilder()

public HttpTargetOrBuilder getHttpTargetOrBuilder()

HTTP target.

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

Returns
Type	Description
HttpTargetOrBuilder

getLastAttemptTime()

public Timestamp getLastAttemptTime()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type	Description
Timestamp	The lastAttemptTime.

getLastAttemptTimeOrBuilder()

public TimestampOrBuilder getLastAttemptTimeOrBuilder()

Output only. The time the last job attempt started.

.google.protobuf.Timestamp last_attempt_time = 18;

Returns
Type	Description
TimestampOrBuilder

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

public String getName()

Optionally caller-specified in CreateJob, after which it becomes output only.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
• LOCATION_ID is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
• JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Optionally caller-specified in CreateJob, after which it becomes output only.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
• LOCATION_ID is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
• JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Job> getParserForType()

Returns
Type	Description
Parser<Job>

Overrides

GeneratedMessageV3.getParserForType()

getPubsubTarget()

public PubsubTarget getPubsubTarget()

Pub/Sub target.

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

Returns
Type	Description
PubsubTarget	The pubsubTarget.

getPubsubTargetOrBuilder()

public PubsubTargetOrBuilder getPubsubTargetOrBuilder()

Pub/Sub target.

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

Returns
Type	Description
PubsubTargetOrBuilder

getRetryConfig()

public RetryConfig getRetryConfig()

Settings that determine the retry behavior.

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

Returns
Type	Description
RetryConfig	The retryConfig.

getRetryConfigOrBuilder()

public RetryConfigOrBuilder getRetryConfigOrBuilder()

Settings that determine the retry behavior.

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

Returns
Type	Description
RetryConfigOrBuilder

getSchedule()

public String getSchedule()

Required, except when used with UpdateJob.

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

• Crontab

• English-like schedule

  As a general rule, execution n + 1 of a job will not begin until execution n has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th execution will not start until 16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs.

  If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.

string schedule = 20;

Returns
Type	Description
String	The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

Required, except when used with UpdateJob.

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

• Crontab

• English-like schedule

  As a general rule, execution n + 1 of a job will not begin until execution n has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th execution will not start until 16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs.

  If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.

string schedule = 20;

Returns
Type	Description
ByteString	The bytes for schedule.

getScheduleTime()

public Timestamp getScheduleTime()

Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type	Description
Timestamp	The scheduleTime.

getScheduleTimeOrBuilder()

public TimestampOrBuilder getScheduleTimeOrBuilder()

Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.

.google.protobuf.Timestamp schedule_time = 17;

Returns
Type	Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public Job.State getState()

Output only. State of the job.

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

Returns
Type	Description
Job.State	The state.

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

Returns
Type	Description
Job.TargetCase

getTimeZone()

public String getTimeZone()

Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database.

Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

string time_zone = 21;

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database.

Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).

string time_zone = 21;

Returns
Type	Description
ByteString	The bytes for timeZone.

getUserUpdateTime()

public Timestamp getUserUpdateTime()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type	Description
Timestamp	The userUpdateTime.

getUserUpdateTimeOrBuilder()

public TimestampOrBuilder getUserUpdateTimeOrBuilder()

Output only. The creation time of the job.

.google.protobuf.Timestamp user_update_time = 9;

Returns
Type	Description
TimestampOrBuilder

hasAppEngineHttpTarget()

public boolean hasAppEngineHttpTarget()

App Engine HTTP target.

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

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Job.Builder newBuilderForType()

Returns
Type	Description
Job.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Job.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Job.Builder toBuilder()

Returns
Type	Description
Job.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException