Struct google_cloudscheduler1_beta1::api::Job
source · pub struct Job {Show 15 fields
pub app_engine_http_target: Option<AppEngineHttpTarget>,
pub attempt_deadline: Option<Duration>,
pub description: Option<String>,
pub http_target: Option<HttpTarget>,
pub last_attempt_time: Option<DateTime<Utc>>,
pub legacy_app_engine_cron: Option<bool>,
pub name: Option<String>,
pub pubsub_target: Option<PubsubTarget>,
pub retry_config: Option<RetryConfig>,
pub schedule: Option<String>,
pub schedule_time: Option<DateTime<Utc>>,
pub state: Option<String>,
pub status: Option<Status>,
pub time_zone: Option<String>,
pub user_update_time: Option<DateTime<Utc>>,
}Expand description
Configuration for a job. The maximum allowed size for a job is 1MB.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- locations jobs create projects (request|response)
- locations jobs get projects (response)
- locations jobs patch projects (request|response)
- locations jobs pause projects (response)
- locations jobs resume projects (response)
- locations jobs run projects (response)
Fields§
§app_engine_http_target: Option<AppEngineHttpTarget>App Engine HTTP target.
attempt_deadline: Option<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.
description: Option<String>Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
http_target: Option<HttpTarget>HTTP target.
last_attempt_time: Option<DateTime<Utc>>Output only. The time the last job attempt started.
legacy_app_engine_cron: Option<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.
name: Option<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.
pubsub_target: Option<PubsubTarget>Pub/Sub target.
retry_config: Option<RetryConfig>Settings that determine the retry behavior.
schedule: Option<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+1th 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. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
schedule_time: Option<DateTime<Utc>>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.
state: Option<String>Output only. State of the job.
status: Option<Status>Output only. The response from the target for the last attempted execution.
time_zone: Option<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).
user_update_time: Option<DateTime<Utc>>Output only. The creation time of the job.