Package com.google.cloud.scheduler.v1beta1

Interface JobOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Job, Job.Builder
    public interface JobOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1beta1.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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Optionally caller-specified in
 [CreateJob][google.cloud.scheduler.v1beta1.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;
        Returns:
        The bytes for name.

      • getDescription

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

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

      • getDescriptionBytes

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

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

      • hasPubsubTarget

        boolean hasPubsubTarget()
         Pub/Sub target.
        .google.cloud.scheduler.v1beta1.PubsubTarget pubsub_target = 4;
        Returns:
        Whether the pubsubTarget field is set.

      • getPubsubTarget

        PubsubTarget getPubsubTarget()
         Pub/Sub target.
        .google.cloud.scheduler.v1beta1.PubsubTarget pubsub_target = 4;
        Returns:
        The pubsubTarget.

      • getPubsubTargetOrBuilder

        PubsubTargetOrBuilder getPubsubTargetOrBuilder()
         Pub/Sub target.
        .google.cloud.scheduler.v1beta1.PubsubTarget pubsub_target = 4;

      • hasAppEngineHttpTarget

        boolean hasAppEngineHttpTarget()
         App Engine HTTP target.
        .google.cloud.scheduler.v1beta1.AppEngineHttpTarget app_engine_http_target = 5;
        Returns:
        Whether the appEngineHttpTarget field is set.

      • getAppEngineHttpTarget

        AppEngineHttpTarget getAppEngineHttpTarget()
         App Engine HTTP target.
        .google.cloud.scheduler.v1beta1.AppEngineHttpTarget app_engine_http_target = 5;
        Returns:
        The appEngineHttpTarget.

      • getAppEngineHttpTargetOrBuilder

        AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()
         App Engine HTTP target.
        .google.cloud.scheduler.v1beta1.AppEngineHttpTarget app_engine_http_target = 5;

      • hasHttpTarget

        boolean hasHttpTarget()
         HTTP target.
        .google.cloud.scheduler.v1beta1.HttpTarget http_target = 6;
        Returns:
        Whether the httpTarget field is set.

      • getHttpTarget

        HttpTarget getHttpTarget()
         HTTP target.
        .google.cloud.scheduler.v1beta1.HttpTarget http_target = 6;
        Returns:
        The httpTarget.

      • getHttpTargetOrBuilder

        HttpTargetOrBuilder getHttpTargetOrBuilder()
         HTTP target.
        .google.cloud.scheduler.v1beta1.HttpTarget http_target = 6;

      • getSchedule

        String getSchedule()
         Required, except when used with
 [UpdateJob][google.cloud.scheduler.v1beta1.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.v1beta1.RetryConfig.retry_count] >
 0 and a job attempt fails, the job will be tried a total of
 [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
 times, with exponential backoff, until the next scheduled start
 time.
        string schedule = 20;
        Returns:
        The schedule.

      • getScheduleBytes

        com.google.protobuf.ByteString getScheduleBytes()
         Required, except when used with
 [UpdateJob][google.cloud.scheduler.v1beta1.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.v1beta1.RetryConfig.retry_count] >
 0 and a job attempt fails, the job will be tried a total of
 [retry_count][google.cloud.scheduler.v1beta1.RetryConfig.retry_count]
 times, with exponential backoff, until the next scheduled start
 time.
        string schedule = 20;
        Returns:
        The bytes for schedule.

      • getTimeZone

        String getTimeZone()
         Specifies the time zone to be used in interpreting
 [schedule][google.cloud.scheduler.v1beta1.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;
        Returns:
        The timeZone.

      • getTimeZoneBytes

        com.google.protobuf.ByteString getTimeZoneBytes()
         Specifies the time zone to be used in interpreting
 [schedule][google.cloud.scheduler.v1beta1.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;
        Returns:
        The bytes for timeZone.

      • hasUserUpdateTime

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

      • getUserUpdateTime

        com.google.protobuf.Timestamp getUserUpdateTime()
         Output only. The creation time of the job.
        .google.protobuf.Timestamp user_update_time = 9;
        Returns:
        The userUpdateTime.

      • getUserUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUserUpdateTimeOrBuilder()
         Output only. The creation time of the job.
        .google.protobuf.Timestamp user_update_time = 9;

      • getStateValue

        int getStateValue()
         Output only. State of the job.
        .google.cloud.scheduler.v1beta1.Job.State state = 10;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Job.State getState()
         Output only. State of the job.
        .google.cloud.scheduler.v1beta1.Job.State state = 10;
        Returns:
        The state.

      • hasStatus

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

      • getStatus

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

      • getStatusOrBuilder

        com.google.rpc.StatusOrBuilder getStatusOrBuilder()
         Output only. The response from the target for the last attempted execution.
        .google.rpc.Status status = 11;

      • hasScheduleTime

        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:
        Whether the scheduleTime field is set.

      • getScheduleTime

        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;
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        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;

      • hasLastAttemptTime

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

      • getLastAttemptTime

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

      • getLastAttemptTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getLastAttemptTimeOrBuilder()
         Output only. The time the last job attempt started.
        .google.protobuf.Timestamp last_attempt_time = 18;

      • hasRetryConfig

        boolean hasRetryConfig()
         Settings that determine the retry behavior.
        .google.cloud.scheduler.v1beta1.RetryConfig retry_config = 19;
        Returns:
        Whether the retryConfig field is set.

      • getRetryConfig

        RetryConfig getRetryConfig()
         Settings that determine the retry behavior.
        .google.cloud.scheduler.v1beta1.RetryConfig retry_config = 19;
        Returns:
        The retryConfig.

      • getRetryConfigOrBuilder

        RetryConfigOrBuilder getRetryConfigOrBuilder()
         Settings that determine the retry behavior.
        .google.cloud.scheduler.v1beta1.RetryConfig retry_config = 19;

      • hasAttemptDeadline

        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.v1beta1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1beta1.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.v1beta1.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.v1beta1.Job.pubsub_target],
 this field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;
        Returns:
        Whether the attemptDeadline field is set.

      • getAttemptDeadline

        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.v1beta1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1beta1.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.v1beta1.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.v1beta1.Job.pubsub_target],
 this field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;
        Returns:
        The attemptDeadline.

      • getAttemptDeadlineOrBuilder

        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.v1beta1.RetryConfig].

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

 * For [HTTP targets][google.cloud.scheduler.v1beta1.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.v1beta1.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.v1beta1.Job.pubsub_target],
 this field is ignored.
        .google.protobuf.Duration attempt_deadline = 22;

      • getLegacyAppEngineCron

        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:
        The legacyAppEngineCron.