Class Job (2.11.0)

Stay organized with collections Save and categorize content based on your preferences.
Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for a job. The maximum allowed size for a job is 1MB.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof:


name str
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
description str
Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
Pub/Sub target. This field is a member of oneof_ target.
App Engine HTTP target. This field is a member of oneof_ target.
HTTP target. This field is a member of oneof_ target.
schedule str
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+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.
time_zone str
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
user_update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time of the job.
Output only. State of the job.
status google.rpc.status_pb2.Status
Output only. The response from the target for the last attempted execution.
schedule_time google.protobuf.timestamp_pb2.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.
last_attempt_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time the last job attempt started.
Settings that determine the retry behavior.
attempt_deadline google.protobuf.duration_pb2.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 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][], 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][], this field is ignored.
legacy_app_engine_cron bool
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.




State of the job.

Values: STATE_UNSPECIFIED (0): Unspecified state. ENABLED (1): The job is executing normally. PAUSED (2): The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest. DISABLED (3): The job is disabled by the system due to error. The user cannot directly set a job to be disabled. UPDATE_FAILED (4): The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received.