gcloud beta workbench schedules create - create a schedule

gcloud beta workbench schedules create--region=REGION(--cron-schedule=CRON_SCHEDULE--display-name=DISPLAY_NAME (--execution-display-name=EXECUTION_DISPLAY_NAME--gcs-output-uri=GCS_OUTPUT_URI--service-account=SERVICE_ACCOUNT ([--gcs-notebook-uri=GCS_NOTEBOOK_URI :--generation=GENERATION]) :--execution-timeout=EXECUTION_TIMEOUT; default="24h"--kernel-name=KERNEL_NAME; default="python3"--accelerator-count=ACCELERATOR_COUNT--accelerator-type=ACCELERATOR_TYPE--machine-type=MACHINE_TYPE; default="e2-standard-4"--disk-size-gb=DISK_SIZE_GB; default=100--disk-type=DISK_TYPE; default="PD_STANDARD"--no-enable-internet-access--network=NETWORK [--subnetwork=SUBNETWORK :--subnetwork-region=SUBNETWORK_REGION] [--kms-key=KMS_KEY :--kms-keyring=KMS_KEYRING--kms-location=KMS_LOCATION--kms-project=KMS_PROJECT]) :--enable-queueing--end-time=END_TIME--max-concurrent-runs=MAX_CONCURRENT_RUNS; default=1--max-runs=MAX_RUNS--start-time=START_TIME)[GCLOUD_WIDE_FLAG …]

• display name:my-schedule,
• cron schedule:TZ=America/Los_Angeles * * * * *,
• maximum concurrent runs allowed: 1,
• start time: 2025-01-01T00:00:00-06:00,

for a notebook execution job:

• with display namemy-execution,
• running notebook file from Cloud Storage URIgs://my-bucket/my-notebook.ipynb,
• running with service accountmy-service-account@my-project.iam.gserviceaccount.com,
• with results uploaded to Cloud Storage bucketgs://my-bucket/results
• with machine typen1-standard-4,

Run the following command:

gcloudbetaworkbenchschedulescreate--region=us-central1--display-name=my-schedule--cron-schedule='TZ=America/Los_Angeles * * * * *'--max-concurrent-runs=1--start-time=2025-01-01T00:00:00-06:00--execution-display-name=my-execution--gcs-notebook-uri=gs://my-bucket/my-notebook.ipynb--service-account=my-service-account@my-project.iam.gserviceaccount.com--gcs-output-uri=gs://my-bucket/results--machine-type=n1-standard-4

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 inother ways.

To set theproject attribute:

• provide the argument--region on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

--region=REGION

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

To set theregion attribute:

• provide the argument--region on the command line.

Configuration of the schedule.

This must be specified.

--cron-schedule=CRON_SCHEDULE

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. Toexplicitly 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} mayonly be a valid string from IANA time zone database. For example,"CRON_TZ=America/New_York 1 * * *", or "TZ=America/New_York 1 * * *".

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

--display-name=DISPLAY_NAME

The display name of the schedule.

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

--enable-queueing

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

--end-time=END_TIME

Timestamp after which no new runs can be scheduled. If specified, the schedulewill 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, newruns will keep getting scheduled until this Schedule is paused or deleted. Mustbe 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"

--max-concurrent-runs=MAX_CONCURRENT_RUNS; default=1

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

--max-runs=MAX_RUNS

The max runs for the schedule.

--start-time=START_TIME

The timestamp after which the first run can be scheduled. Defaults to theschedule 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"

Configuration of the execution job.

This must be specified.

--execution-display-name=EXECUTION_DISPLAY_NAME

The display name of the execution.

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

--gcs-output-uri=GCS_OUTPUT_URI

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 groupare specified.

--service-account=SERVICE_ACCOUNT

The service account to run the execution as

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

--execution-timeout=EXECUTION_TIMEOUT; default="24h"

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

--kernel-name=KERNEL_NAME; default="python3"

The kernel name to use for the execution.

Source of the notebook to execute.

This must be specified.

The Cloud Storage notebook source.

--gcs-notebook-uri=GCS_NOTEBOOK_URI

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 groupare specified.

--generation=GENERATION

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

Compute configuration of the execution job.

The machine configuration of the runtime.

--accelerator-count=ACCELERATOR_COUNT

The number of accelerators used by the runtime.

--accelerator-type=ACCELERATOR_TYPE

The type of hardware accelerator used by the runtime. If specified,--accelerator-count must also be specified.ACCELERATOR_TYPE must be one of:NVIDIA_TESLA_V100,NVIDIA_TESLA_T4,NVIDIA_TESLA_A100,NVIDIA_A100_80GB,NVIDIA_L4.

--machine-type=MACHINE_TYPE; default="e2-standard-4"

The Compute Engine machine type selected for the runtime.

The configuration for the data disk of the runtime.

--disk-size-gb=DISK_SIZE_GB; default=100

The disk size of the runtime in GB. If specified, the --disk-type must also bespecified. The minimum size is 10GB and the maximum is 65536GB.

--disk-type=DISK_TYPE; default="PD_STANDARD"

The type of the persistent disk.DISK_TYPE must be oneof:PD_STANDARD,PD_SSD,PD_BALANCED,PD_EXTREME.

The network configuration for the runtime.

--enable-internet-access

Enable public internet access for the runtime. Enabled by default, use--no-enable-internet-access to disable.

Network resource - The name of the VPC that this runtime is in. This representsa Cloud resource. (NOTE) Some attributes are not given arguments in this groupbut can be set in other ways.

To set theproject attribute:

• provide the argument--network on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

--network=NETWORK

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

To set thenetwork attribute:

• provide the argument--network on the command line.

Subnetwork resource - The name of the subnetwork that this runtime is in. Thearguments 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 inother ways.

To set theproject attribute:

• provide the argument--subnetwork on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

--subnetwork=SUBNETWORK

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

To set thesubnetwork attribute:

• provide the argument--subnetwork on the command line.

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

--subnetwork-region=SUBNETWORK_REGION

Google Cloud region of this subnetworkhttps://cloud.google.com/compute/docs/regions-zones/#locations.

To set thesubnetwork-region attribute:

• provide the argument--subnetwork on the command line with a fullyspecified name;
• provide the argument--subnetwork-region on the command line.

Key resource - The Cloud KMS encryption key (customer-managed encryption key)used to protect the execution. The key must be in the same region as theexecution. If not specified, Google-managed encryption will be used. Thearguments in this group can be used to specify the attributes of this resource.

--kms-key=KMS_KEY

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

To set thekms-key attribute:

• provide the argument--kms-key on the command line.

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

--kms-keyring=KMS_KEYRING

KMS keyring id of the key.

To set thekms-keyring attribute:

• provide the argument--kms-key on the command line with a fullyspecified name;
• provide the argument--kms-keyring on the command line.

--kms-location=KMS_LOCATION

Cloud location for the key.

To set thekms-location attribute:

• provide the argument--kms-key on the command line with a fullyspecified name;
• provide the argument--kms-location on the command line.

--kms-project=KMS_PROJECT

Cloud project id for the key.

To set thekms-project attribute:

• provide the argument--kms-key on the command line with a fullyspecified name;
• provide the argument--kms-project on the command line.

Run$gcloud help for details.