Class: Google::Apis::CloudschedulerV1::Job

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudscheduler_v1/classes.rb,
generated/google/apis/cloudscheduler_v1/representations.rb,
generated/google/apis/cloudscheduler_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



396
397
398
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 396

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_http_target ⇒ Google::Apis::CloudschedulerV1::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

Returns:



282
283
284
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 282

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. Corresponds to the JSON property attemptDeadline

Returns:

  • (String) 


292
293
294
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 292

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

Returns:

  • (String) 


298
299
300
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 298

def description
  @description
end

#http_target ⇒ Google::Apis::CloudschedulerV1::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

Returns:



307
308
309
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 307

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

Returns:

  • (String) 


312
313
314
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 312

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 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. Corresponds to the JSON property name

Returns:

  • (String) 


326
327
328
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 326

def name
  @name
end

#pubsub_target ⇒ Google::Apis::CloudschedulerV1::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

Returns:



332
333
334
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 332

def pubsub_target
  @pubsub_target
end

#retry_config ⇒ Google::Apis::CloudschedulerV1::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

Returns:



340
341
342
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 340

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 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+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 > 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 property schedule

Returns:

  • (String) 


357
358
359
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 357

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

Returns:

  • (String) 


364
365
366
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 364

def schedule_time
  @schedule_time
end

#state ⇒ String

Output only. State of the job. Corresponds to the JSON property state

Returns:

  • (String) 


369
370
371
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 369

def state
  @state
end

#status ⇒ Google::Apis::CloudschedulerV1::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

Returns:



379
380
381
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 379

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

Returns:

  • (String) 


389
390
391
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 389

def time_zone
  @time_zone
end

#user_update_time ⇒ String

Output only. The creation time of the job. Corresponds to the JSON property userUpdateTime

Returns:

  • (String) 


394
395
396
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 394

def user_update_time
  @user_update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 401

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