Cloud Scheduler V1 API - Class Google::Cloud::Scheduler::V1::Job (v0.5.0)

Reference documentation and code samples for the Cloud Scheduler V1 API class Google::Cloud::Scheduler::V1::Job.

Configuration for a job. The maximum allowed size for a job is 100KB.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_engine_http_target

def app_engine_http_target() -> ::Google::Cloud::Scheduler::V1::AppEngineHttpTarget
Returns

#app_engine_http_target=

def app_engine_http_target=(value) -> ::Google::Cloud::Scheduler::V1::AppEngineHttpTarget
Parameter
Returns

#attempt_deadline

def attempt_deadline() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) —

    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:

#attempt_deadline=

def attempt_deadline=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) —

    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:

Returns
  • (::Google::Protobuf::Duration) —

    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:

#description

def description() -> ::String
Returns
  • (::String) — Optionally caller-specified in CreateJob or UpdateJob.

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

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optionally caller-specified in CreateJob or UpdateJob.

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

Returns
  • (::String) — Optionally caller-specified in CreateJob or UpdateJob.

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

#http_target

def http_target() -> ::Google::Cloud::Scheduler::V1::HttpTarget
Returns

#http_target=

def http_target=(value) -> ::Google::Cloud::Scheduler::V1::HttpTarget
Parameter
Returns

#last_attempt_time

def last_attempt_time() -> ::Google::Protobuf::Timestamp
Returns

#last_attempt_time=

def last_attempt_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) —

    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][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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

    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][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.
Returns
  • (::String) —

    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][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.

#pubsub_target

def pubsub_target() -> ::Google::Cloud::Scheduler::V1::PubsubTarget
Returns

#pubsub_target=

def pubsub_target=(value) -> ::Google::Cloud::Scheduler::V1::PubsubTarget
Parameter
Returns

#retry_config

def retry_config() -> ::Google::Cloud::Scheduler::V1::RetryConfig
Returns

#retry_config=

def retry_config=(value) -> ::Google::Cloud::Scheduler::V1::RetryConfig
Parameter
Returns

#schedule

def schedule() -> ::String
Returns
  • (::String) — 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:

    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.

#schedule=

def schedule=(value) -> ::String
Parameter
  • value (::String) — 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:

    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.

Returns
  • (::String) — 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:

    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.

#schedule_time

def schedule_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#schedule_time=

def schedule_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#state

def state() -> ::Google::Cloud::Scheduler::V1::Job::State
Returns

#state=

def state=(value) -> ::Google::Cloud::Scheduler::V1::Job::State
Parameter
Returns

#status

def status() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::Status) — Output only. The response from the target for the last attempted execution.

#status=

def status=(value) -> ::Google::Rpc::Status
Parameter
  • value (::Google::Rpc::Status) — Output only. The response from the target for the last attempted execution.
Returns
  • (::Google::Rpc::Status) — Output only. The response from the target for the last attempted execution.

#time_zone

def time_zone() -> ::String
Returns
  • (::String) — 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).

#time_zone=

def time_zone=(value) -> ::String
Parameter
  • value (::String) — 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).

Returns
  • (::String) — 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).

#user_update_time

def user_update_time() -> ::Google::Protobuf::Timestamp
Returns

#user_update_time=

def user_update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns