.TH "GCLOUD_COLAB_SCHEDULES_UPDATE" 1



.SH "NAME"
.HP
gcloud colab schedules update \- update a schedule



.SH "SYNOPSIS"
.HP
\f5gcloud colab schedules update\fR (\fISCHEDULE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) (\fB\-\-cron\-schedule\fR=\fICRON_SCHEDULE\fR\ \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR\ \fB\-\-enable\-queueing\fR\ \fB\-\-end\-time\fR=\fIEND_TIME\fR\ \fB\-\-max\-concurrent\-runs\fR=\fIMAX_CONCURRENT_RUNS\fR\ \fB\-\-max\-runs\fR=\fIMAX_RUNS\fR\ \fB\-\-start\-time\fR=\fISTART_TIME\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Colab Enterprise notebook execution schedule.



.SH "EXAMPLES"

To update the cron schedule and max runs of a schedule with id
\f5my\-schedule\fR, in region \f5us\-central1\fR, run:

.RS 2m
$ gcloud colab schedules update my\-schedule \-\-region=us\-central1 \e
    \-\-cron\-schedule='TZ=America/Los_Angeles 0 0 * * 0' \-\-max\-runs=2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Schedule resource \- Unique, system\-generated resource name of the schedule 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5schedule\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fISCHEDULE\fR

ID of the schedule or fully qualified identifier for the schedule.

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5schedule\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Cloud region for the schedule.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5schedule\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5colab/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Configuration of the schedule.

At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-cron\-schedule\fR=\fICRON_SCHEDULE\fR

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To
explicitly set a timezone to the cron tab, apply a prefix in the cron tab:
"CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may
only be a valid string from IANA time zone database. For example,
"CRON_TZ=America/New_York 1 * * * \fB", or "TZ=America/New_York 1 * * * \fR".

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

The display name of the schedule.

.TP 2m
\fB\-\-enable\-queueing\fR

Enables new scheduled runs to be queued when max_concurrent_runs limit is
reached. If set to true, new runs will be queued instead of skipped.

.TP 2m
\fB\-\-end\-time\fR=\fIEND_TIME\fR

Timestamp after which no new runs can be scheduled. If specified, the schedule
will be completed when either end_time is reached or when scheduled_run_count >=
max_run_count. If neither end time nor max_run_count is specified, new runs will
keep getting scheduled until this Schedule is paused or deleted. Must be in the
RFC 3339 (https://www.rfc\-editor.org/rfc/rfc3339.txt) format. E.g.
"2026\-01\-01T00:00:00Z" or "2026\-01\-01T00:00:00\-05:00"

.TP 2m
\fB\-\-max\-concurrent\-runs\fR=\fIMAX_CONCURRENT_RUNS\fR

Maximum number of runs that can be started concurrently for this Schedule. This
is the limit for starting the scheduled requests and not the execution of the
notebook execution jobs created by the requests.

.TP 2m
\fB\-\-max\-runs\fR=\fIMAX_RUNS\fR

The max runs for the schedule.

.TP 2m
\fB\-\-start\-time\fR=\fISTART_TIME\fR

The timestamp after which the first run can be scheduled. Defaults to the
schedule creation time. Must be in the RFC 3339
(https://www.rfc\-editor.org/rfc/rfc3339.txt) format. E.g.
"2026\-01\-01T00:00:00Z" or "2026\-01\-01T00:00:00\-05:00"


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud beta colab schedules update
.RE