Class: Google::Apis::CloudschedulerV1beta1::Job
- Inherits:
-
Object
- Object
- Google::Apis::CloudschedulerV1beta1::Job
- Defined in:
- generated/google/apis/cloudscheduler_v1beta1/classes.rb,
generated/google/apis/cloudscheduler_v1beta1/representations.rb,
generated/google/apis/cloudscheduler_v1beta1/representations.rb
Overview
Configuration for a job. The maximum allowed size for a job is 100KB.
Instance Attribute Summary collapse
-
#app_engine_http_target ⇒ Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget
App Engine target.
-
#attempt_deadline ⇒ String
The deadline for job attempts.
-
#description ⇒ String
Optionally caller-specified in CreateJob or UpdateJob.
-
#http_target ⇒ Google::Apis::CloudschedulerV1beta1::HttpTarget
Http target.
-
#last_attempt_time ⇒ String
Output only.
-
#name ⇒ String
Optionally caller-specified in CreateJob, after which it becomes output only.
-
#pubsub_target ⇒ Google::Apis::CloudschedulerV1beta1::PubsubTarget
Pub/Sub target.
-
#retry_config ⇒ Google::Apis::CloudschedulerV1beta1::RetryConfig
Settings that determine the retry behavior.
-
#schedule ⇒ String
Required, except when used with UpdateJob.
-
#schedule_time ⇒ String
Output only.
-
#state ⇒ String
Output only.
-
#status ⇒ Google::Apis::CloudschedulerV1beta1::Status
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. -
#time_zone ⇒ String
Specifies the time zone to be used in interpreting schedule.
-
#user_update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Job
constructor
A new instance of Job.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Job
Returns a new instance of Job.
482 483 484 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 482 def initialize(**args) update!(**args) end |
Instance Attribute Details
#app_engine_http_target ⇒ Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget
App Engine target. The job will be pushed to a job handler by means
of an HTTP request via an http_method such
as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an
HTTP response code in the range [200 - 299]. Error 503 is
considered an App Engine system error instead of an application
error. Requests returning error 503 will be retried regardless of
retry configuration and not counted against retry counts. Any other
response code, or a failure to receive a response before the
deadline, constitutes a failed attempt.
Corresponds to the JSON property appEngineHttpTarget
347 348 349 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 347 def app_engine_http_target @app_engine_http_target end |
#attempt_deadline ⇒ String
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:
- For HTTP targets, between 15 seconds and 30 minutes.
- For App Engine HTTP targets, between 15 seconds and 24 hours.
- For PubSub targets, this field is ignored.
Corresponds to the JSON property
attemptDeadline
361 362 363 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 361 def attempt_deadline @attempt_deadline end |
#description ⇒ String
Optionally caller-specified in CreateJob or
UpdateJob.
A human-readable description for the job. This string must not contain
more than 500 characters.
Corresponds to the JSON property description
369 370 371 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 369 def description @description end |
#http_target ⇒ Google::Apis::CloudschedulerV1beta1::HttpTarget
Http target. The job will be pushed to the job handler by means of
an HTTP request via an http_method such as HTTP
POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
response code in the range [200 - 299]. A failure to receive a response
constitutes a failed execution. For a redirected request, the response
returned by the redirected request is considered.
Corresponds to the JSON property httpTarget
379 380 381 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 379 def http_target @http_target end |
#last_attempt_time ⇒ String
Output only. The time the last job attempt started.
Corresponds to the JSON property lastAttemptTime
384 385 386 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 384 def last_attempt_time @last_attempt_time end |
#name ⇒ 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 projectsLOCATION_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. Corresponds to the JSON propertyname
404 405 406 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 404 def name @name end |
#pubsub_target ⇒ Google::Apis::CloudschedulerV1beta1::PubsubTarget
Pub/Sub target. The job will be delivered by publishing a message to
the given Pub/Sub topic.
Corresponds to the JSON property pubsubTarget
410 411 412 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 410 def pubsub_target @pubsub_target end |
#retry_config ⇒ Google::Apis::CloudschedulerV1beta1::RetryConfig
Settings that determine the retry behavior.
By default, if a job does not complete successfully (meaning that
an acknowledgement is not received from the handler, then it will be retried
with exponential backoff according to the settings in RetryConfig.
Corresponds to the JSON property retryConfig
418 419 420 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 418 def retry_config @retry_config end |
#schedule ⇒ 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:
- Crontab
- English-like
schedule
As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16: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. Corresponds to the JSON propertyschedule
441 442 443 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 441 def schedule @schedule end |
#schedule_time ⇒ String
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.
Corresponds to the JSON property scheduleTime
448 449 450 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 448 def schedule_time @schedule_time end |
#state ⇒ String
Output only. State of the job.
Corresponds to the JSON property state
453 454 455 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 453 def state @state end |
#status ⇒ Google::Apis::CloudschedulerV1beta1::Status
The Status
type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
API Design Guide.
Corresponds to the JSON property status
463 464 465 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 463 def status @status end |
#time_zone ⇒ 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).
Corresponds to the JSON property timeZone
475 476 477 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 475 def time_zone @time_zone end |
#user_update_time ⇒ String
Output only. The creation time of the job.
Corresponds to the JSON property userUpdateTime
480 481 482 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 480 def user_update_time @user_update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'generated/google/apis/cloudscheduler_v1beta1/classes.rb', line 487 def update!(**args) @app_engine_http_target = args[:app_engine_http_target] if args.key?(:app_engine_http_target) @attempt_deadline = args[:attempt_deadline] if args.key?(:attempt_deadline) @description = args[:description] if args.key?(:description) @http_target = args[:http_target] if args.key?(:http_target) @last_attempt_time = args[:last_attempt_time] if args.key?(:last_attempt_time) @name = args[:name] if args.key?(:name) @pubsub_target = args[:pubsub_target] if args.key?(:pubsub_target) @retry_config = args[:retry_config] if args.key?(:retry_config) @schedule = args[:schedule] if args.key?(:schedule) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) @state = args[:state] if args.key?(:state) @status = args[:status] if args.key?(:status) @time_zone = args[:time_zone] if args.key?(:time_zone) @user_update_time = args[:user_update_time] if args.key?(:user_update_time) end |