gcloud scheduler jobs create app-engine

NAME
gcloud scheduler jobs create app-engine - create a Cloud Scheduler job with an App Engine target
SYNOPSIS
gcloud scheduler jobs create app-engine(JOB :--location=LOCATION)--schedule=SCHEDULE[--attempt-deadline=ATTEMPT_DEADLINE][--description=DESCRIPTION][--headers=[KEY=VALUE,…]][--http-method=HTTP_METHOD; default="post"][--max-backoff=MAX_BACKOFF; default="3600s"][--max-doublings=MAX_DOUBLINGS; default=5][--max-retry-attempts=MAX_RETRY_ATTEMPTS][--max-retry-duration=MAX_RETRY_DURATION][--min-backoff=MIN_BACKOFF; default="5s"][--relative-url=RELATIVE_URL; default="/"][--service=SERVICE][--time-zone=TIME_ZONE; default="Etc/UTC"][--version=VERSION][--message-body=MESSAGE_BODY    |--message-body-from-file=PATH_TO_FILE][GCLOUD_WIDE_FLAG]
DESCRIPTION
Create a Cloud Scheduler job with an App Engine target.
EXAMPLES
The following command creates a job that sends a request to the '/cron-handler'path in you App Engine app every 3 hours:
gcloudschedulerjobscreateapp-enginemy-job--schedule="0 */3 * * *"--relative-url="/cron-handler"
POSITIONAL ARGUMENTS
Job resource - Job to create. The arguments in this group can be used to specifythe attributes of this resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentjob on the command line with a fully specifiedname;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

JOB
ID of the job or fully qualified identifier for the job.

To set thejob attribute:

  • provide the argumentjob on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--location=LOCATION
The location of the job. By default, uses the location of the current project'sApp Engine app if there is an associated app.To set thelocation attribute:
  • provide the argumentjob on the command line with a fully specifiedname;
  • provide the argument--location on the command line;
  • defaults to App Engine's app location if not provided & an app exists.
REQUIRED FLAGS
--schedule=SCHEDULE
Schedule on which the job will be executed.

As a general rule, executionn + 1 of a job will not begin untilexecutionn has finished. Cloud Scheduler will never allow twosimultaneously outstanding executions. For example, this implies that if then+1 execution is scheduled to run at16:00 but then execution takes until16:15, then+1execution will not start until16:15. A scheduled start time willbe delayed if the previous execution has not ended when its scheduled timeoccurs. Learn more about thecronjob format.

If--retry-count > 0 and a job attempt fails, the job will betried a total of--retry-count times, with exponential backoff,until the job succeeds or the number of retries is exhausted. Note that the nextscheduled execution time might be skipped if the retries continue through thattime. For more information, seeRetryjobs.

OPTIONAL FLAGS
--attempt-deadline=ATTEMPT_DEADLINE
The deadline for job attempts. If the request handler doesn't respond by thisdealine, the request is cancelled and the attempt is marked as failed. Forexample, 20s.
--description=DESCRIPTION
Human-readable description of the job.
--headers=[KEY=VALUE,…]
KEY=VALUE pairs of HTTP headers to include in the request.Cannot berepeated. For example:--headersAccept-Language=en-us,Accept=text/plain
--http-method=HTTP_METHOD; default="post"
HTTP method to use for the request.HTTP_METHOD must beone of:delete,get,head,post,put.
--max-backoff=MAX_BACKOFF; default="3600s"
Maximum amount of time to wait before retrying a job after it fails. Forexample,60s. Default is3600s (1 hour).
--max-doublings=MAX_DOUBLINGS; default=5
Maximum number of times that the interval between failed job retries will bedoubled before the increase becomes constant.
--max-retry-attempts=MAX_RETRY_ATTEMPTS
Number of times to retry the request if it fails or times out. Must be in range0-5 inclusive. Default is 0.
--max-retry-duration=MAX_RETRY_DURATION
Time limit for retrying a failed job, measured from when the job was first run.If specified with--max-retry-attempts greater than 0, the job willbe retried until both limits are reached. Default is 0 seconds (which meansunlimited); however, if--max-retry-attempts is also 0, a jobattempt won't be retried if it fails.
--min-backoff=MIN_BACKOFF; default="5s"
Minimum amount of time to wait before retrying a job after it fails. Forexample,10s. Default is5s.
--relative-url=RELATIVE_URL; default="/"
Relative URL to use for the request (beginning with "/").
--service=SERVICE
ID of the App Engine service to send the request to.
--time-zone=TIME_ZONE; default="Etc/UTC"
Specifies the time zone to be used in interpreting --schedule. The value of thisfield 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. Therules for daylight saving time are determined by the chosen time zone.

For UTC use the string "utc". Default is "utc".

--version=VERSION
Version of the App Engine service to send the request to.
At most one of these can be specified:
--message-body=MESSAGE_BODY
Data payload to be included as the body of the HTTP request. May only be givenwith compatible HTTP methods (PUT or POST).
--message-body-from-file=PATH_TO_FILE
Path to file containing the data payload to be included as the body of the HTTPrequest. May only be given with compatible HTTP methods (PUT or POST). Use afull or relative path to a local file containing the value of message_body.
GCLOUD WIDE FLAGS
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.

API REFERENCE
This command uses thecloudscheduler/v1 API. The full documentationfor this API can be found at:https://cloud.google.com/scheduler/
NOTES
These variants are also available:
gcloudalphaschedulerjobscreateapp-engine
gcloudbetaschedulerjobscreateapp-engine

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-29 UTC.