- NAME
-
- gcloud scheduler jobs update pubsub - update a Cloud Scheduler job with a Pub/Sub target
- SYNOPSIS
-
-
gcloud scheduler jobs update pubsub
(JOB
:--location
=LOCATION
) [--description
=DESCRIPTION
] [--schedule
=SCHEDULE
] [--topic
=TOPIC
] [--clear-attributes
|--remove-attributes
=[REMOVE_ATTRIBUTES
,…]--update-attributes
=[KEY
=VALUE
,…]] [--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-min-backoff
|--min-backoff
=MIN_BACKOFF
; default="5s"] [--clear-time-zone
|--time-zone
=TIME_ZONE
; default="Etc/UTC"] [--message-body
=MESSAGE_BODY
|--message-body-from-file
=PATH_TO_FILE
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Update a Cloud Scheduler job with a Pub/Sub target.
- EXAMPLES
-
Update my-job's retry attempt limit:
gcloud scheduler jobs update pubsub my-job --max-retry-attempts=2
- POSITIONAL ARGUMENTS
-
-
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.
-
provide the argument
--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.
-
provide the argument
-
provide the argument
-
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.
- FLAGS
-
--description
=DESCRIPTION
- Human-readable description of the job.
--schedule
=SCHEDULE
-
Schedule on which the job will be executed.
As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
execution is scheduled to run at16:00
but then
execution takes until16:15
, then+1
execution will not start until16: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
--topic
=TOPIC
- Name of the Google Cloud Pub/Sub topic to publish to when the job runs.
-
At most one of these can be specified:
--clear-attributes
-
Clear the field corresponding to
--attributes
. --remove-attributes
=[REMOVE_ATTRIBUTES
,…]- Comma-separated list of attribute keys to remove with the form "KEY1,KEY2".
--update-attributes
=[KEY
=VALUE
,…]- Comma-separated list of attributes. Each attribute has the form "NAME=VALUE". You can specify up to 100 attributes.
-
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 is1h
.
-
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-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 is5s
.
-
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".
-
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
At most one of these can be specified:
--message-body
=MESSAGE_BODY
- Body of the message.
--message-body-from-file
=PATH_TO_FILE
- Path to a file containing the body of the message. Use a full 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 the
cloudscheduler/v1
API. The full documentation for this API can be found at: https://cloud.google.com/scheduler/ - NOTES
-
These variants are also available:
gcloud alpha scheduler jobs update pubsub
gcloud beta scheduler jobs update pubsub
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 2024-07-30 UTC.