Package com.google.cloud.scheduler.v1

Class Job

  • All Implemented Interfaces:
    JobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Job
extends com.google.protobuf.GeneratedMessageV3
implements JobOrBuilder
     Configuration for a job.
 The maximum allowed size for a job is 1MB.
    Protobuf type google.cloud.scheduler.v1.Job
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1.CloudScheduler.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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the job's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.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;
        Specified by:
        getName in interface JobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1.CloudScheduler.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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the job's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.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;
        Specified by:
        getNameBytes in interface JobOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or
 [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

 A human-readable description for the job. This string must not contain
 more than 500 characters.
        string description = 2;
        Specified by:
        getDescription in interface JobOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or
 [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

 A human-readable description for the job. This string must not contain
 more than 500 characters.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface JobOrBuilder
        Returns:
        The bytes for description.

      • hasPubsubTarget

        public boolean hasPubsubTarget()
         Pub/Sub target.
        .google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
        Specified by:
        hasPubsubTarget in interface JobOrBuilder
        Returns:
        Whether the pubsubTarget field is set.

      • getPubsubTarget

        public PubsubTarget getPubsubTarget()
         Pub/Sub target.
        .google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
        Specified by:
        getPubsubTarget in interface JobOrBuilder
        Returns:
        The pubsubTarget.

      • hasAppEngineHttpTarget

        public boolean hasAppEngineHttpTarget()
         App Engine HTTP target.
        .google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
        Specified by:
        hasAppEngineHttpTarget in interface JobOrBuilder
        Returns:
        Whether the appEngineHttpTarget field is set.

      • getAppEngineHttpTarget

        public AppEngineHttpTarget getAppEngineHttpTarget()
         App Engine HTTP target.
        .google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
        Specified by:
        getAppEngineHttpTarget in interface JobOrBuilder
        Returns:
        The appEngineHttpTarget.

      • hasHttpTarget

        public boolean hasHttpTarget()
         HTTP target.
        .google.cloud.scheduler.v1.HttpTarget http_target = 6;
        Specified by:
        hasHttpTarget in interface JobOrBuilder
        Returns:
        Whether the httpTarget field is set.

      • getHttpTarget

        public HttpTarget getHttpTarget()
         HTTP target.
        .google.cloud.scheduler.v1.HttpTarget http_target = 6;
        Specified by:
        getHttpTarget in interface JobOrBuilder
        Returns:
        The httpTarget.

      • getSchedule

        public String getSchedule()
         Required, except when used with
 [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

 Describes the schedule on which the job will be executed.

 The schedule can be either of the following types:

 * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)
 * English-like
 [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

 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][google.cloud.scheduler.v1.RetryConfig.retry_count] > 0 and
 a job attempt fails, the job will be tried a total of
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times,
 with exponential backoff, until the next scheduled start time.
        string schedule = 20;
        Specified by:
        getSchedule in interface JobOrBuilder
        Returns:
        The schedule.

      • getScheduleBytes

        public com.google.protobuf.ByteString getScheduleBytes()
         Required, except when used with
 [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

 Describes the schedule on which the job will be executed.

 The schedule can be either of the following types:

 * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)
 * English-like
 [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

 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][google.cloud.scheduler.v1.RetryConfig.retry_count] > 0 and
 a job attempt fails, the job will be tried a total of
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times,
 with exponential backoff, until the next scheduled start time.
        string schedule = 20;
        Specified by:
        getScheduleBytes in interface JobOrBuilder
        Returns:
        The bytes for schedule.

      • getTimeZone

        public String getTimeZone()
         Specifies the time zone to be used in interpreting
 [schedule][google.cloud.scheduler.v1.Job.schedule]. The value of this field
 must be a time zone name from the [tz
 database](http://en.wikipedia.org/wiki/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;
        Specified by:
        getTimeZone in interface JobOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.ByteString getTimeZoneBytes()
         Specifies the time zone to be used in interpreting
 [schedule][google.cloud.scheduler.v1.Job.schedule]. The value of this field
 must be a time zone name from the [tz
 database](http://en.wikipedia.org/wiki/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;
        Specified by:
        getTimeZoneBytes in interface JobOrBuilder
        Returns:
        The bytes for timeZone.

      • hasUserUpdateTime

        public boolean hasUserUpdateTime()
         Output only. The creation time of the job.
        .google.protobuf.Timestamp user_update_time = 9;
        Specified by:
        hasUserUpdateTime in interface JobOrBuilder
        Returns:
        Whether the userUpdateTime field is set.

      • getUserUpdateTime

        public com.google.protobuf.Timestamp getUserUpdateTime()
         Output only. The creation time of the job.
        .google.protobuf.Timestamp user_update_time = 9;
        Specified by:
        getUserUpdateTime in interface JobOrBuilder
        Returns:
        The userUpdateTime.

      • getUserUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUserUpdateTimeOrBuilder()
         Output only. The creation time of the job.
        .google.protobuf.Timestamp user_update_time = 9;
        Specified by:
        getUserUpdateTimeOrBuilder in interface JobOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. State of the job.
        .google.cloud.scheduler.v1.Job.State state = 10;
        Specified by:
        getStateValue in interface JobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Job.State getState()
         Output only. State of the job.
        .google.cloud.scheduler.v1.Job.State state = 10;
        Specified by:
        getState in interface JobOrBuilder
        Returns:
        The state.

      • hasStatus

        public boolean hasStatus()
         Output only. The response from the target for the last attempted execution.
        .google.rpc.Status status = 11;
        Specified by:
        hasStatus in interface JobOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public com.google.rpc.Status getStatus()
         Output only. The response from the target for the last attempted execution.
        .google.rpc.Status status = 11;
        Specified by:
        getStatus in interface JobOrBuilder
        Returns:
        The status.

      • getStatusOrBuilder

        public com.google.rpc.StatusOrBuilder getStatusOrBuilder()
         Output only. The response from the target for the last attempted execution.
        .google.rpc.Status status = 11;
        Specified by:
        getStatusOrBuilder in interface JobOrBuilder

      • 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;
        Specified by:
        hasScheduleTime in interface JobOrBuilder
        Returns:
        Whether the scheduleTime field is set.

      • getScheduleTime

        public com.google.protobuf.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;
        Specified by:
        getScheduleTime in interface JobOrBuilder
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getScheduleTimeOrBuilder in interface JobOrBuilder

      • hasLastAttemptTime

        public boolean hasLastAttemptTime()
         Output only. The time the last job attempt started.
        .google.protobuf.Timestamp last_attempt_time = 18;
        Specified by:
        hasLastAttemptTime in interface JobOrBuilder
        Returns:
        Whether the lastAttemptTime field is set.

      • getLastAttemptTime

        public com.google.protobuf.Timestamp getLastAttemptTime()
         Output only. The time the last job attempt started.
        .google.protobuf.Timestamp last_attempt_time = 18;
        Specified by:
        getLastAttemptTime in interface JobOrBuilder
        Returns:
        The lastAttemptTime.

      • getLastAttemptTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getLastAttemptTimeOrBuilder()
         Output only. The time the last job attempt started.
        .google.protobuf.Timestamp last_attempt_time = 18;
        Specified by:
        getLastAttemptTimeOrBuilder in interface JobOrBuilder

      • hasRetryConfig

        public boolean hasRetryConfig()
         Settings that determine the retry behavior.
        .google.cloud.scheduler.v1.RetryConfig retry_config = 19;
        Specified by:
        hasRetryConfig in interface JobOrBuilder
        Returns:
        Whether the retryConfig field is set.

      • getRetryConfig

        public RetryConfig getRetryConfig()
         Settings that determine the retry behavior.
        .google.cloud.scheduler.v1.RetryConfig retry_config = 19;
        Specified by:
        getRetryConfig in interface JobOrBuilder
        Returns:
        The retryConfig.

      • 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][google.cloud.scheduler.v1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the
 default is 3 minutes. The deadline must be in the interval [15 seconds, 30
 minutes].

 * For [App Engine HTTP
 targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 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][google.cloud.scheduler.v1.Job.pubsub_target], this
 field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;
        Specified by:
        hasAttemptDeadline in interface JobOrBuilder
        Returns:
        Whether the attemptDeadline field is set.

      • getAttemptDeadline

        public com.google.protobuf.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][google.cloud.scheduler.v1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the
 default is 3 minutes. The deadline must be in the interval [15 seconds, 30
 minutes].

 * For [App Engine HTTP
 targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 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][google.cloud.scheduler.v1.Job.pubsub_target], this
 field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;
        Specified by:
        getAttemptDeadline in interface JobOrBuilder
        Returns:
        The attemptDeadline.

      • getAttemptDeadlineOrBuilder

        public com.google.protobuf.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][google.cloud.scheduler.v1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the
 default is 3 minutes. The deadline must be in the interval [15 seconds, 30
 minutes].

 * For [App Engine HTTP
 targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 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][google.cloud.scheduler.v1.Job.pubsub_target], this
 field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;
        Specified by:
        getAttemptDeadlineOrBuilder in interface JobOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Job parseFrom​(ByteBuffer data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(ByteBuffer data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.ByteString data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.ByteString data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(byte[] data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(byte[] data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseDelimitedFrom

        public static Job parseDelimitedFrom​(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.CodedInputStream input)
                     throws IOException
        Throws:
        IOException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.CodedInputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Job.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilder

        public static Job.Builder newBuilder​(Job prototype)

      • toBuilder

        public Job.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Job.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Job getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Job> parser()

      • getParserForType

        public com.google.protobuf.Parser<Job> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Job getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder