gcloud beta scheduler jobs update app-engine - update a Cloud Scheduler job with an App Engine target
gcloud beta scheduler jobs update app-engine (JOB : --location=LOCATION) [--attempt-deadline=ATTEMPT_DEADLINE] [--description=DESCRIPTION] [--http-method=HTTP_METHOD; default="post"] [--schedule=SCHEDULE] [--version=VERSION] [--clear-headers | --remove-headers=[REMOVE_HEADERS,...] --update-headers=[UPDATE_HEADERS,...]] [--clear-max-backoff | --max-backoff=MAX_BACKOFF; default="1h"] [--clear-max-doublings | --max-doublings=MAX_DOUBLINGS; default=16] [--clear-max-retry-attempts | --max-retry-attempts=MAX_RETRY_ATTEMPTS] [--clear-max-retry-duration | --max-retry-duration=MAX_RETRY_DURATION] [--clear-message-body | --message-body=MESSAGE_BODY | --message-body-from-file=MESSAGE_BODY_FROM_FILE] [--clear-min-backoff | --min-backoff=MIN_BACKOFF; default="5s"] [--clear-relative-url | --relative-url=RELATIVE_URL; default="/"] [--clear-service | --service=SERVICE; default="default"] [--clear-time-zone | --time-zone=TIME_ZONE; default="Etc/UTC"] [GCLOUD_WIDE_FLAG ...]
(BETA) Update a Cloud Scheduler job with an App Engine target.
Update my-job's retry attempt limit:
$ gcloud beta scheduler jobs update app-engine my-job \ --max-retry-attempts=2
- Job resource - Job to update. The arguments in this group can be used to
specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:
- —
provide the argument job on the command line with a fully specified name;
- —
provide the argument --project on the command line;
- —
set the property core/project.
This must be specified.
- JOB
ID of the job or fully qualified identifier for the job. To set the job attribute:
provide the argument job on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- --location=LOCATION
The location of the job. By default, uses the location of the current project's App Engine app if there is an associated app.
To set the location attribute:
provide the argument job on the command line with a fully specified name;
provide the argument --location on the command line;
defaults to App Engine's app location if not provided & an app exists.
- --attempt-deadline=ATTEMPT_DEADLINE
The deadline for job attempts. If the request handler doesn't respond by this dealine, the request is cancelled and the attempt is marked as failed. For example, 20s.
- --description=DESCRIPTION
Human-readable description of the job.
- --http-method=HTTP_METHOD; default="post"
HTTP method to use for the request. HTTP_METHOD must be one of: delete, get, head, post, put.
- --schedule=SCHEDULE
Schedule on which the job will be executed.
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 execution is scheduled to run at 16:00 but the n execution takes until 16:15, the n+1 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.
The schedule can be either of the following types:
- —
- —
English-like schedule: https://cloud.google.com/scheduler/docs/quickstart#defining_the_job_schedule
- --version=VERSION
Version of the App Engine service to send the request to.
- At most one of these can be specified:
- --clear-headers
Clear the list of HTTP headers.
- --remove-headers=[REMOVE_HEADERS,...]
KEY1,KEY2 list of HTTP headers to remove from the request. --remove-headers Accept-Language,Accept
- --update-headers=[UPDATE_HEADERS,...]
KEY=VALUE pairs of HTTP headers to include in the request. Cannot be repeated. For example: --update-headers Accept-Language=en-us,Accept=text/plain
- At most one of these can be specified:
- --clear-max-backoff
Clear the field corresponding to --max-backoff.
- --max-backoff=MAX_BACKOFF; default="1h"
Maximum amount of time to wait before retrying a task after it fails. For example, 10m. Default is 1h.
- At most one of these can be specified:
- --clear-max-doublings
Clear the field corresponding to --max-doublings.
- --max-doublings=MAX_DOUBLINGS; default=16
Maximum number of times that the interval between failed job retries will be doubled before the increase becomes constant.
- At most one of these can be specified:
- --clear-max-retry-attempts
Clear the field corresponding to --max-retry-attempts.
- --max-retry-attempts=MAX_RETRY_ATTEMPTS
Number of times to retry the request if it fails or times out. Must be in range 0-5 inclusive. Default is 0.
- At most one of these can be specified:
- --clear-max-retry-duration
Clear the field corresponding to --max-retry-duration.
- --max-retry-duration=MAX_RETRY_DURATION
Time limit for retrying a failed task, measured from when the task was first run. If specified with --max-retry-attempts greater than 0, the task will be retried until both limits are reached. Default is 0 (which means unlimited).
- At most one of these can be specified:
- --clear-message-body
Clear the field corresponding to --message-body or --message-body-from-file.
- --message-body=MESSAGE_BODY
Data payload to be included as the body of the HTTP request. May only be given with compatible HTTP methods (PUT or POST).
- --message-body-from-file=MESSAGE_BODY_FROM_FILE
Path to file containing the data payload to be included as the body of the HTTP request. May only be given with compatible HTTP methods (PUT or POST).
- At most one of these can be specified:
- --clear-min-backoff
Clear the field corresponding to --min-backoff.
- --min-backoff=MIN_BACKOFF; default="5s"
Minimum amount of time to wait before retrying a task after it fails. For example, 10s. Default is 5s.
- At most one of these can be specified:
- --clear-relative-url
Clear the field corresponding to --relative-url.
- --relative-url=RELATIVE_URL; default="/"
Relative URL to use for the request (beginning with "/").
- At most one of these can be specified:
- --clear-service
Clear the field corresponding to --service.
- --service=SERVICE; default="default"
ID of the App Engine service to send the request to.
- At most one of these can be specified:
- --clear-time-zone
Clear the field corresponding to --time-zone.
- --time-zone=TIME_ZONE; default="Etc/UTC"
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 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen time zone.
For UTC use the string "utc". Default is "utc".
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
This command uses the cloudscheduler/v1 API. The full documentation for this API can be found at: https://cloud.google.com/scheduler/
This command is currently in beta and might change without notice. These variants are also available:
$ gcloud scheduler jobs update app-engine
$ gcloud alpha scheduler jobs update app-engine