Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Configuration for a job. The maximum allowed size for a job is 100KB.
Attributes
Name | Description |
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. |
pubsub_target |
google.cloud.scheduler_v1beta1.types.PubsubTarget
Pub/Sub target. |
app_engine_http_target |
google.cloud.scheduler_v1beta1.types.AppEngineHttpTarget
App Engine HTTP target. |
http_target |
google.cloud.scheduler_v1beta1.types.HttpTarget
HTTP 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. |
state |
google.cloud.scheduler_v1beta1.types.Job.State
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. |
retry_config |
google.cloud.scheduler_v1beta1.types.RetryConfig
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 allowed duration for this deadline is:
- For [HTTP
targets][google.cloud.scheduler.v1beta1.Job.http_target],
between 15 seconds and 30 minutes.
- For [App Engine HTTP
targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target],
between 15 seconds and 24 hours.
- For [PubSub
targets][google.cloud.scheduler.v1beta1.Job.pubsub_target],
this field is ignored.
|
Classes
State
State(value)
State of the job.