imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00
Code Activity

gcloud: Wed Feb 26 10:38:18 UTC 2025

Browse source
This commit is contained in:
Automated 2025-02-26 10:38:18 +00:00
parent 8d1a988ab5
commit a597993b2e
186 changed files with 5629 additions and 923 deletions
Download patch file Download diff file Expand all files Collapse all files

245
gcloud/beta/workbench/executions/create Normal file
View file

@ -0,0 +1,245 @@
NAME
gcloud beta workbench executions create - create a Workbench execution
SYNOPSIS
gcloud beta workbench executions create --region=REGION
(--display-name=DISPLAY_NAME --gcs-output-uri=GCS_OUTPUT_URI
--service-account=SERVICE_ACCOUNT (--direct-content=DIRECT_CONTENT
| [--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]) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create a Workbench notebook execution.
EXAMPLES
To create an execution of a notebook file with Cloud Storage URI
gs://my-bucket/my-notebook.ipynb, with an execution job display name
my-execution, running with service account
my-service-account@my-project.iam.gserviceaccount.com, with results
uploaded to Cloud Storage bucket gs://my-bucket/results, and in region
us-central1, with a compute configuration of n1-standard-4 machine type:
$ gcloud beta workbench executions create \
--display-name=my-execution \
--gcs-notebook-uri=gs://my-bucket/my-notebook.ipynb \
--service-account=my-service-account@my-project.iam.gserviceacco\
unt.com --gcs-output-uri=gs://my-bucket/results \
--region=us-central1 --machine-type=n1-standard-4
REQUIRED FLAGS
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 project attribute:
◆ provide the argument --region 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.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line.
Configuration of the execution job.
This must be specified.
--display-name=DISPLAY_NAME
The display name of the execution.
This flag argument must be specified if any of the other arguments in
this group are 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 group are 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 group are specified.
--execution-timeout=EXECUTION_TIMEOUT; default="24h"
The max running time of the execution job, as a duration. See '$
gcloud topic datetimes' for details 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.
Exactly one of these must be specified:
--direct-content=DIRECT_CONTENT
The direct notebook content as IPYNB. This can be a local filepath
to an .ipynb file or can be set to - to read content from stdin.
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 group are specified.
--generation=GENERATION
The version of the Cloud Storage object to read. If unset, the
current version of 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 be specified. 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 one of:
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
represents a Cloud 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 --network on the command line with a fully
specified name;
◇ provide the argument --project on the command line;
◇ set the property core/project.
--network=NETWORK
ID of the network or fully qualified identifier for the
network.
To set the network attribute:
▹ provide the argument --network on the command line.
Subnetwork resource - The name of the subnetwork that this runtime
is in. 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 --subnetwork on the command line with a
fully specified name;
◇ provide the argument --project on the command line;
◇ set the property core/project.
--subnetwork=SUBNETWORK
ID of the subnetwork or fully qualified identifier for the
subnetwork.
To set the subnetwork attribute:
▹ provide the argument --subnetwork on the command line.
This flag argument must be specified if any of the other
arguments in this group are specified.
--subnetwork-region=SUBNETWORK_REGION
Google Cloud region of this subnetwork
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the subnetwork-region attribute:
▹ provide the argument --subnetwork on the command line with
a fully specified 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 the execution. If not specified, Google-managed encryption will be
used. The arguments 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 the kms-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 group are specified.
--kms-keyring=KMS_KEYRING
KMS keyring id of the key.
To set the kms-keyring attribute:
▫ provide the argument --kms-key on the command line with a fully
specified name;
▫ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
Cloud location for the key.
To set the kms-location attribute:
▫ provide the argument --kms-key on the command line with a fully
specified name;
▫ provide the argument --kms-location on the command line.
--kms-project=KMS_PROJECT
Cloud project id for the key.
To set the kms-project attribute:
▫ provide the argument --kms-key on the command line with a fully
specified name;
▫ provide the argument --kms-project on the command line.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
NOTES
This command is currently in beta and might change without notice.

64
gcloud/beta/workbench/executions/delete Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud beta workbench executions delete - delete an execution
SYNOPSIS
gcloud beta workbench executions delete (EXECUTION : --region=REGION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete a Workbench notebook execution.
EXAMPLES
To delete an execution with id my-execution, in region us-central1, run:
$ gcloud beta workbench executions delete my-execution \
--region=us-central1
POSITIONAL ARGUMENTS
Notebook execution job resource - Unique resource name of the execution to
delete. 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 execution 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.
EXECUTION
ID of the notebook execution job or fully qualified identifier for
the notebook execution job.
To set the name attribute:
▸ provide the argument execution on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the notebook execution job.
To set the region attribute:
▸ provide the argument execution on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
NOTES
This command is currently in beta and might change without notice.

60
gcloud/beta/workbench/executions/describe Normal file
View file

@ -0,0 +1,60 @@
NAME
gcloud beta workbench executions describe - describe an execution
SYNOPSIS
gcloud beta workbench executions describe (EXECUTION : --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a Workbench notebook execution.
EXAMPLES
To describe a notebook execution with id my-execution in region
us-central1, run:
$ gcloud beta workbench executions describe my-execution \
--region=us-central1
POSITIONAL ARGUMENTS
Notebook execution job resource - Unique resource name of the execution to
describe. 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 execution 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.
EXECUTION
ID of the notebook execution job or fully qualified identifier for
the notebook execution job.
To set the name attribute:
▸ provide the argument execution on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the notebook execution job.
To set the region attribute:
▸ provide the argument execution on the command line with a fully
specified name;
▸ provide the argument --region on the command line.
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.
NOTES
This command is currently in beta and might change without notice.

32
gcloud/beta/workbench/executions/help Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud beta workbench executions - workbench executions command group
SYNOPSIS
gcloud beta workbench executions COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Workbench executions command group.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a Workbench execution.
delete
(BETA) Delete an execution.
describe
(BETA) Describe an execution.
list
(BETA) List your notebook execution jobs.
NOTES
This command is currently in beta and might change without notice.

78
gcloud/beta/workbench/executions/list Normal file
View file

@ -0,0 +1,78 @@
NAME
gcloud beta workbench executions list - list your notebook execution jobs
SYNOPSIS
gcloud beta workbench executions list --region=REGION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List your project's Workbench executions in a given region.
EXAMPLES
To list your executions in region us-central1, run:
$ gcloud beta workbench executions list --region=us-central1
REQUIRED FLAGS
Region resource - Cloud region for which to list all executions. 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 project attribute:
◆ provide the argument --region 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.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
NOTES
This command is currently in beta and might change without notice.

9
gcloud/beta/workbench/help
View file

@ -12,6 +12,15 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
executions
(BETA) Workbench executions command group.
schedules
(BETA) Workbench schedules command group.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:

305
gcloud/beta/workbench/schedules/create Normal file
View file

@ -0,0 +1,305 @@
NAME
gcloud beta workbench schedules create - create a schedule
SYNOPSIS
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 ...]
DESCRIPTION
(BETA) Create a schedule to run a Workbench notebook execution job.
EXAMPLES
To create a schedule in region us-central1 with the following schedule
properties:
▪ 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 name my-execution,
▪ running notebook file from Cloud Storage URI
gs://my-bucket/my-notebook.ipynb,
▪ running with service account
my-service-account@my-project.iam.gserviceaccount.com,
▪ with results uploaded to Cloud Storage bucket gs://my-bucket/results
▪ with machine type n1-standard-4,
Run the following command: $ gcloud beta workbench schedules create --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.gserviceacco\
unt.com --gcs-output-uri=gs://my-bucket/results \
--machine-type=n1-standard-4
REQUIRED FLAGS
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 project attribute:
◆ provide the argument --region 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.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region 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. 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 * * * ", or "TZ=America/New_York 1 * * *
".
This flag argument must be specified if any of the other arguments in
this group are 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 group are specified.
--enable-queueing
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.
--end-time=END_TIME
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.ietf.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. This is the limit for starting the scheduled requests and
not the execution of the notebook 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
the schedule creation time. Must be in the RFC 3339
(https://www.ietf.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 group are 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 group are 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 group are specified.
--execution-timeout=EXECUTION_TIMEOUT; default="24h"
The max running time of the execution job, as a duration. See '$
gcloud topic datetimes' for details 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 group are specified.
--generation=GENERATION
The version of the Cloud Storage object to read. If unset, the
current version of 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 be specified. 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 one of:
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 represents a Cloud 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 --network on the command line with a
fully specified name;
▹ provide the argument --project on the command line;
▹ set the property core/project.
--network=NETWORK
ID of the network or fully qualified identifier for the
network.
To set the network attribute:
▪ provide the argument --network on the command line.
Subnetwork resource - The name of the subnetwork that this runtime
is in. 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 --subnetwork on the command line with a
fully specified name;
▹ provide the argument --project on the command line;
▹ set the property core/project.
--subnetwork=SUBNETWORK
ID of the subnetwork or fully qualified identifier for the
subnetwork.
To set the subnetwork attribute:
▪ provide the argument --subnetwork on the command line.
This flag argument must be specified if any of the other
arguments in this group are specified.
--subnetwork-region=SUBNETWORK_REGION
Google Cloud region of this subnetwork
https://cloud.google.com/compute/docs/regions-zones/#locations.
To set the subnetwork-region attribute:
▪ provide the argument --subnetwork on the command line
with a fully specified 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 the execution. If not specified, Google-managed
encryption will be used. The arguments 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 the kms-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 group are specified.
--kms-keyring=KMS_KEYRING
KMS keyring id of the key.
To set the kms-keyring attribute:
◇ provide the argument --kms-key on the command line with a
fully specified name;
◇ provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
Cloud location for the key.
To set the kms-location attribute:
◇ provide the argument --kms-key on the command line with a
fully specified name;
◇ provide the argument --kms-location on the command line.
--kms-project=KMS_PROJECT
Cloud project id for the key.
To set the kms-project attribute:
◇ provide the argument --kms-key on the command line with a
fully specified name;
◇ provide the argument --kms-project on the command line.
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.
NOTES
This command is currently in beta and might change without notice.

64
gcloud/beta/workbench/schedules/delete Normal file
View file

@ -0,0 +1,64 @@
NAME
gcloud beta workbench schedules delete - delete a schedule
SYNOPSIS
gcloud beta workbench schedules delete (SCHEDULE : --region=REGION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete a Workbench notebook execution schedule.
EXAMPLES
To delete a schedule with id my-schedule, in region us-central1, run:
$ gcloud beta workbench schedules delete my-schedule \
--region=us-central1
POSITIONAL ARGUMENTS
Schedule resource - Unique, system-generated resource name of the schedule
to delete. 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 schedule 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.
SCHEDULE
ID of the schedule or fully qualified identifier for the schedule.
To set the name attribute:
▸ provide the argument schedule on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the schedule.
To set the region attribute:
▸ provide the argument schedule on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
NOTES
This command is currently in beta and might change without notice.

59
gcloud/beta/workbench/schedules/describe Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud beta workbench schedules describe - describe a schedule
SYNOPSIS
gcloud beta workbench schedules describe (SCHEDULE : --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe a Workbench notebook execution schedule.
EXAMPLES
To describe a schedule with id my-schedule in region us-central1, run:
$ gcloud beta workbench schedules describe my-schedule \
--region=us-central1
POSITIONAL ARGUMENTS
Schedule resource - Unique, system-generated resource name of the schedule
to describe. 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 schedule 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.
SCHEDULE
ID of the schedule or fully qualified identifier for the schedule.
To set the name attribute:
▸ provide the argument schedule on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the schedule.
To set the region attribute:
▸ provide the argument schedule on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
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.
NOTES
This command is currently in beta and might change without notice.

41
gcloud/beta/workbench/schedules/help Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud beta workbench schedules - workbench schedules command group
SYNOPSIS
gcloud beta workbench schedules COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Workbench schedules command group.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a schedule.
delete
(BETA) Delete a schedule.
describe
(BETA) Describe a schedule.
list
(BETA) List your Workbench notebook execution schedules.
pause
(BETA) Pause a schedule.
resume
(BETA) Resume a schedule.
update
(BETA) Update a schedule.
NOTES
This command is currently in beta and might change without notice.

80
gcloud/beta/workbench/schedules/list Normal file
View file

@ -0,0 +1,80 @@
NAME
gcloud beta workbench schedules list - list your Workbench notebook
execution schedules
SYNOPSIS
gcloud beta workbench schedules list --region=REGION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List your project's Workbench notebook execution schedules in a
given region.
EXAMPLES
To list your schedules in region us-central1, run:
$ gcloud beta workbench schedules list --region=us-central1
REQUIRED FLAGS
Region resource - Cloud region for which to list all schedules. 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 project attribute:
◆ provide the argument --region 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.
--region=REGION
ID of the region or fully qualified identifier for the region.
To set the region attribute:
▸ provide the argument --region on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
NOTES
This command is currently in beta and might change without notice.

59
gcloud/beta/workbench/schedules/pause Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud beta workbench schedules pause - pause a schedule
SYNOPSIS
gcloud beta workbench schedules pause (SCHEDULE : --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Pause a Workbench notebook execution schedule.
EXAMPLES
To pause a schedule with id my-schedule, in region us-central1, run:
$ gcloud beta workbench schedules pause my-schedule \
--region=us-central1
POSITIONAL ARGUMENTS
Schedule resource - Unique, system-generated resource name of the schedule
to pause. 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 schedule 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.
SCHEDULE
ID of the schedule or fully qualified identifier for the schedule.
To set the name attribute:
▸ provide the argument schedule on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the schedule.
To set the region attribute:
▸ provide the argument schedule on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
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.
NOTES
This command is currently in beta and might change without notice.

66
gcloud/beta/workbench/schedules/resume Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud beta workbench schedules resume - resume a schedule
SYNOPSIS
gcloud beta workbench schedules resume (SCHEDULE : --region=REGION)
[--enable-catch-up] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Resume a Workbench notebook execution schedule.
EXAMPLES
To resume a paused schedule with id my-schedule, in region us-central1,
run:
$ gcloud beta workbench schedules resume my-schedule \
--region=us-central1
POSITIONAL ARGUMENTS
Schedule resource - Unique, system-generated resource name of the schedule
to resume. 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 schedule 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.
SCHEDULE
ID of the schedule or fully qualified identifier for the schedule.
To set the name attribute:
▸ provide the argument schedule on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the schedule.
To set the region attribute:
▸ provide the argument schedule on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
FLAGS
--enable-catch-up
Enables backfilling missed runs when the schedule is resumed from
PAUSED state. If enabled, all missed runs will be scheduled and new
runs will be scheduled after the backfill is complete.
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.
NOTES
This command is currently in beta and might change without notice.

110
gcloud/beta/workbench/schedules/update Normal file
View file

@ -0,0 +1,110 @@
NAME
gcloud beta workbench schedules update - update a schedule
SYNOPSIS
gcloud beta workbench schedules update (SCHEDULE : --region=REGION)
(--cron-schedule=CRON_SCHEDULE --display-name=DISPLAY_NAME
--enable-queueing --end-time=END_TIME
--max-concurrent-runs=MAX_CONCURRENT_RUNS
--max-runs=MAX_RUNS --start-time=START_TIME) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a Workbench notebook execution schedule.
EXAMPLES
To update the cron schedule and max runs of a schedule with id my-schedule,
in region us-central1, run:
$ gcloud beta workbench schedules update my-schedule \
--region=us-central1 \
--cron-schedule='TZ=America/Los_Angeles 0 0 * * 0' --max-runs=2
POSITIONAL ARGUMENTS
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 project attribute:
◆ provide the argument schedule 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.
SCHEDULE
ID of the schedule or fully qualified identifier for the schedule.
To set the name attribute:
▸ provide the argument schedule on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Cloud region for the schedule.
To set the region attribute:
▸ provide the argument schedule on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property colab/region.
REQUIRED FLAGS
Configuration of the schedule.
At least one of these must be specified:
--cron-schedule=CRON_SCHEDULE
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 * * * ", or "TZ=America/New_York 1 * * *
".
--display-name=DISPLAY_NAME
The display name of the schedule.
--enable-queueing
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.
--end-time=END_TIME
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.ietf.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
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.
--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
the schedule creation time. Must be in the RFC 3339
(https://www.ietf.org/rfc/rfc3339.txt) format. E.g.
"2026-01-01T00:00:00Z" or "2026-01-01T00:00:00-05:00"
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.
NOTES
This command is currently in beta and might change without notice.