- gcloud scheduler jobs create pubsub - create a Cloud Scheduler job with a Pub/Sub target
gcloud scheduler jobs create pubsub
MAX_BACKOFF; default="1h"] [
MAX_DOUBLINGS; default=16] [
MIN_BACKOFF; default="5s"] [
TIME_ZONE; default="Etc/UTC"] [
- Create a Cloud Scheduler job with a Pub/Sub target.
The following command creates a job that publishes a messgae with the body
'Hello' to the Pub/Sub topic 'cron-topic' every 3 hours:
gcloud scheduler jobs create pubsub my-job --schedule="0 */3 * * *"--topic=cron-topic --message-body="Hello"
- POSITIONAL ARGUMENTS
Job resource - Job to create. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute: provide the argument
jobon the command line with a fully specified name; provide the argument
--projecton the command line; set the property
core/project. To set the
locationattribute: provide the argument
jobon the command line with a fully specified name; as the location of the current project's App Engine App. This must be specified.
ID of the job or fully qualified identifier for the job. To set the
jobattribute: provide the argument
jobon the command line.
- Job resource - Job to create. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the
- REQUIRED FLAGS
Schedule on which the job will be executed.
As a general rule, execution
n + 1of a job will not begin until execution
nhas finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the
n+1execution is scheduled to run at
nexecution takes until
n+1execution 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:
- Crontab: http://en.wikipedia.org/wiki/Cron#Overview
- English-like schedule: https://cloud.google.com/scheduler/docs/quickstart#defining_the_job_schedule
- Name of the Google Cloud Pub/Sub topic to publish to when the job runs.
Body of the message to publish to the given topic name. Information on message
formatting and size limits can be found at: https://cloud.google.com/pubsub/docs/publisher#publish
Exactly one of these must be specified:
- Body of the message.
- Path to a file containing the body of the message.
- OPTIONAL FLAGS
- Comma-separated list of attributes. Each attribute has the form "NAME=VALUE". You can specify up to 100 attributes.
- Human-readable description of the job.
Maximum amount of time to wait before retrying a task after it fails. For
10m. Default is
- Maximum number of times that the interval between failed job retries will be doubled before the increase becomes constant.
- Number of times to retry the request if it fails or times out. Must be in range 0-5 inclusive. Default is 0.
Time limit for retrying a failed task, measured from when the task was first
run. If specified with
--max-retry-attemptsgreater than 0, the task will be retried until both limits are reached. Default is 0 (which means unlimited).
Minimum amount of time to wait before retrying a task after it fails. For
10s. Default is
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 time zone.
For UTC use the string "utc". Default is "utc".
- GCLOUD WIDE FLAGS
These flags are available to all commands:
$ gcloud helpfor details.
- API REFERENCE
This command uses the
cloudscheduler/v1API. The full documentation for this API can be found at: https://cloud.google.com/scheduler/
- These variants are also available:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-03-23 UTC.