class Google::Apis::CloudschedulerV1beta1::Job
Configuration for a job. The maximum allowed size for a job is 100KB.
Attributes
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` @return [Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget]
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` @return [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` @return [String]
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` @return [Google::Apis::CloudschedulerV1beta1::HttpTarget]
Output only. The time the last job attempt started. Corresponds to the JSON property `lastAttemptTime` @return [String]
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. Corresponds to the JSON property `legacyAppEngineCron` @return [Boolean]
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. Corresponds to the JSON property `legacyAppEngineCron` @return [Boolean]
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](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. For more information, see 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` @return [String]
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. Corresponds to the JSON property `pubsubTarget` @return [Google::Apis::CloudschedulerV1beta1::PubsubTarget]
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` @return [Google::Apis::CloudschedulerV1beta1::RetryConfig]
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](en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule]( 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 > 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` @return [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` @return [String]
Output only. State of the job. Corresponds to the JSON property `state` @return [String]
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](github.com/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](https: //cloud.google.com/apis/design/errors). Corresponds to the JSON property `status` @return [Google::Apis::CloudschedulerV1beta1::Status]
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](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). Corresponds to the JSON property `timeZone` @return [String]
Output only. The creation time of the job. Corresponds to the JSON property `userUpdateTime` @return [String]
Public Class Methods
# File lib/google/apis/cloudscheduler_v1beta1/classes.rb, line 406 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/cloudscheduler_v1beta1/classes.rb, line 411 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) @legacy_app_engine_cron = args[:legacy_app_engine_cron] if args.key?(:legacy_app_engine_cron) @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