Class: Google::Cloud::Scheduler::V1beta1::Job
- Inherits:
-
Object
- Object
- Google::Cloud::Scheduler::V1beta1::Job
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/scheduler/v1beta1/job.rb
Overview
Configuration for a job. The maximum allowed size for a job is 1MB.
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#app_engine_http_target ⇒ ::Google::Cloud::Scheduler::V1beta1::AppEngineHttpTarget
App Engine HTTP target.
-
#attempt_deadline ⇒ ::Google::Protobuf::Duration
The deadline for job attempts.
- #description ⇒ ::String
-
#http_target ⇒ ::Google::Cloud::Scheduler::V1beta1::HttpTarget
HTTP target.
-
#last_attempt_time ⇒ ::Google::Protobuf::Timestamp
Output only.
-
#legacy_app_engine_cron ⇒ ::Boolean
Immutable.
-
#name ⇒ ::String
Optionally caller-specified in CreateJob, after which it becomes output only.
-
#pubsub_target ⇒ ::Google::Cloud::Scheduler::V1beta1::PubsubTarget
Pub/Sub target.
-
#retry_config ⇒ ::Google::Cloud::Scheduler::V1beta1::RetryConfig
Settings that determine the retry behavior.
-
#schedule ⇒ ::String
Required, except when used with UpdateJob.
-
#schedule_time ⇒ ::Google::Protobuf::Timestamp
Output only.
-
#state ⇒ ::Google::Cloud::Scheduler::V1beta1::Job::State
Output only.
-
#status ⇒ ::Google::Rpc::Status
Output only.
-
#time_zone ⇒ ::String
Specifies the time zone to be used in interpreting schedule.
-
#user_update_time ⇒ ::Google::Protobuf::Timestamp
Output only.
Instance Attribute Details
#app_engine_http_target ⇒ ::Google::Cloud::Scheduler::V1beta1::AppEngineHttpTarget
Returns App Engine HTTP target.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#attempt_deadline ⇒ ::Google::Protobuf::Duration
Returns 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 default and the allowed values depend on the type of target:
For HTTP targets, 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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#description ⇒ ::String
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#http_target ⇒ ::Google::Cloud::Scheduler::V1beta1::HttpTarget
Returns HTTP target.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#last_attempt_time ⇒ ::Google::Protobuf::Timestamp
Returns Output only. The time the last job attempt started.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#legacy_app_engine_cron ⇒ ::Boolean
Returns 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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#name ⇒ ::String
Returns 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::Google::Cloud::Location::Locations::Client#list_locations
. 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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#pubsub_target ⇒ ::Google::Cloud::Scheduler::V1beta1::PubsubTarget
Returns Pub/Sub target.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#retry_config ⇒ ::Google::Cloud::Scheduler::V1beta1::RetryConfig
Returns Settings that determine the retry behavior.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#schedule ⇒ ::String
Returns 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+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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#schedule_time ⇒ ::Google::Protobuf::Timestamp
Returns 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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#state ⇒ ::Google::Cloud::Scheduler::V1beta1::Job::State
Returns Output only. State of the job.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#status ⇒ ::Google::Rpc::Status
Returns Output only. The response from the target for the last attempted execution.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#time_zone ⇒ ::String
Returns 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).
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |
#user_update_time ⇒ ::Google::Protobuf::Timestamp
Returns Output only. The creation time of the job.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'proto_docs/google/cloud/scheduler/v1beta1/job.rb', line 153 class Job include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the job. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The job is executing normally. ENABLED = 1 # The job is paused by the user. It will not execute. A user can # intentionally pause the job using # {::Google::Cloud::Scheduler::V1beta1::PauseJobRequest PauseJobRequest}. PAUSED = 2 # The job is disabled by the system due to error. The user # cannot directly set a job to be disabled. DISABLED = 3 # The job state resulting from a failed # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # operation. To recover a job from this state, retry # {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob} # until a successful response is received. UPDATE_FAILED = 4 end end |