.TH "GCLOUD_BETA_COLAB_SCHEDULES_CREATE" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud beta colab schedules create\fR (\fB\-\-cron\-schedule\fR=\fICRON_SCHEDULE\fR\ \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR\ (\fB\-\-execution\-display\-name\fR=\fIEXECUTION_DISPLAY_NAME\fR\ \fB\-\-gcs\-output\-uri\fR=\fIGCS_OUTPUT_URI\fR\ \fB\-\-notebook\-runtime\-template\fR=\fINOTEBOOK_RUNTIME_TEMPLATE\fR\ ([\fB\-\-dataform\-repository\-name\fR=\fIDATAFORM_REPOSITORY_NAME\fR\ :\ \fB\-\-commit\-sha\fR=\fICOMMIT_SHA\fR]\ |\ [\fB\-\-gcs\-notebook\-uri\fR=\fIGCS_NOTEBOOK_URI\fR\ :\ \fB\-\-generation\fR=\fIGENERATION\fR])\ (\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR\ |\ \fB\-\-user\-email\fR=\fIUSER_EMAIL\fR)\ :\ \fB\-\-execution\-timeout\fR=\fIEXECUTION_TIMEOUT\fR;\ default="24h")\ :\ \fB\-\-enable\-queueing\fR\ \fB\-\-end\-time\fR=\fIEND_TIME\fR\ \fB\-\-max\-concurrent\-runs\fR=\fIMAX_CONCURRENT_RUNS\fR;\ default=1\ \fB\-\-max\-runs\fR=\fIMAX_RUNS\fR\ \fB\-\-start\-time\fR=\fISTART_TIME\fR) [\fB\-\-region\fR=\fIREGION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Create a schedule to run a Colab Enterprise notebook execution job.



.SH "EXAMPLES"

To create a schedule in region \f5us\-central1\fR with the following schedule
properties:
.RS 2m
.IP "\(bu" 2m
display name: \f5my\-schedule\fR,
.IP "\(bu" 2m
cron schedule: \f5TZ=America/Los_Angeles * * * * *\fR,
.IP "\(bu" 2m
maximum concurrent runs allowed: 1,
.IP "\(bu" 2m
start time: 2025\-01\-01T00:00:00\-06:00,
.RE
.sp

for a notebook execution job:
.RS 2m
.IP "\(bu" 2m
with display name \f5my\-execution\fR,
.IP "\(bu" 2m
running notebook file from Cloud Storage URI
\f5gs://my\-bucket/my\-notebook.ipynb\fR,
.IP "\(bu" 2m
compute configured from runtime template \f5my\-runtime\-template\-id\fR,
.IP "\(bu" 2m
running with service account
\f5my\-service\-account@my\-project.iam.gserviceaccount.com\fR,
.IP "\(bu" 2m
with results uploaded to Cloud Storage bucket \f5gs://my\-bucket/results\fR
.RE
.sp

Run the following command:.RS 2m
$ gcloud beta colab schedules create \-\-region=us\-central1 \e
    \-\-display\-name=my\-schedule \e
    \-\-cron\-schedule='TZ=America/Los_Angeles * * * * *' \e
    \-\-max\-concurrent\-runs=1 \-\-start\-time=2025\-01\-01T00:00:00\-06:00 \e
    \-\-execution\-display\-name=my\-execution \e
    \-\-notebook\-runtime\-template=my\-runtime\-template\-id \e
    \-\-gcs\-notebook\-uri=gs://my\-bucket/my\-notebook.ipynb \e
    \-\-service\-account=my\-service\-account@my\-project.iam.gserviceacco\e
unt.com \-\-gcs\-output\-uri=gs://my\-bucket/results

.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Configuration of the schedule.

This 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".

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

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

The display name of the schedule.

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

.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; default=1

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"

.TP 2m

Configuration of the execution job.

This must be specified.


.RS 2m
.TP 2m
\fB\-\-execution\-display\-name\fR=\fIEXECUTION_DISPLAY_NAME\fR

The display name of the execution.

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

.TP 2m
\fB\-\-gcs\-output\-uri\fR=\fIGCS_OUTPUT_URI\fR

The Cloud Storage location to upload notebook execution results to. Format:
gs://bucket\-name.

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

.TP 2m

Notebook runtime template resource \- The runtime template specifying the
compute configuration for the notebook execution. The runtime template should be
in the same region as the execution. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-notebook\-runtime\-template\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

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

This must be specified.


.RS 2m
.TP 2m
\fB\-\-notebook\-runtime\-template\fR=\fINOTEBOOK_RUNTIME_TEMPLATE\fR

ID of the notebook runtime template or fully qualified identifier for the
notebook runtime template.

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-notebook\-runtime\-template\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m
\fB\-\-execution\-timeout\fR=\fIEXECUTION_TIMEOUT\fR; default="24h"

The max running time of the execution job, as a duration. See '$ gcloud topic
datetimes' for details on formatting the input duration.

.TP 2m

Source of the notebook to execute.

Exactly one of these must be specified:


.RS 2m
.TP 2m

The Dataform repository containing the notebook. Any notebook created from the
Colab UI is automatically stored in a Dataform repository. The repository name
can be found via the Dataform API by listing repositories in the same project
and region as the notebook.


.RS 2m
.TP 2m

Dataform repository resource \- Unique name of the Dataform repository to source
input notebook from. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-dataform\-repository\-name\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

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

This must be specified.


.RS 2m
.TP 2m
\fB\-\-dataform\-repository\-name\fR=\fIDATAFORM_REPOSITORY_NAME\fR

ID of the dataform repository or fully qualified identifier for the dataform
repository.

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-dataform\-repository\-name\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m
\fB\-\-commit\-sha\fR=\fICOMMIT_SHA\fR

The commit SHA to read from the Dataform repository. If unset, the file will be
read from HEAD.

.RE
.sp
.TP 2m

The Cloud Storage notebook source.


.RS 2m
.TP 2m
\fB\-\-gcs\-notebook\-uri\fR=\fIGCS_NOTEBOOK_URI\fR

The Cloud Storage uri pointing to the notebook. Format:
gs://bucket/notebook_file.ipynb

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

.TP 2m
\fB\-\-generation\fR=\fIGENERATION\fR

The version of the Cloud Storage object to read. If unset, the current version
of the object will be used.

.RE
.RE
.sp
.TP 2m

Identity to run the execution as.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR

The service account to run the execution as.

.TP 2m
\fB\-\-user\-email\fR=\fIUSER_EMAIL\fR

The user email to run the execution as. This requires the provided runtime
template to have end user credentials enabled.


.RE
.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m

Region resource \- Cloud region 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-region\fR on the command line with a fully specified
name;
.IP "\(em" 2m
set the property \f5colab/region\fR 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


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

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

To set the \f5region\fR attribute:
.RS 2m
.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 "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 command is currently in beta and might change without notice. This variant
is also available:

.RS 2m
$ gcloud colab schedules create
.RE