.TH "GCLOUD_BETA_WORKBENCH_EXECUTIONS_CREATE" 1



.SH "NAME"
.HP
gcloud beta workbench executions create \- create a Workbench execution



.SH "SYNOPSIS"
.HP
\f5gcloud beta workbench executions create\fR \fB\-\-region\fR=\fIREGION\fR (\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR\ \fB\-\-gcs\-output\-uri\fR=\fIGCS_OUTPUT_URI\fR\ \fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR\ (\fB\-\-direct\-content\fR=\fIDIRECT_CONTENT\fR\ |\ [\fB\-\-gcs\-notebook\-uri\fR=\fIGCS_NOTEBOOK_URI\fR\ :\ \fB\-\-generation\fR=\fIGENERATION\fR])\ :\ \fB\-\-execution\-timeout\fR=\fIEXECUTION_TIMEOUT\fR;\ default="24h"\ \fB\-\-kernel\-name\fR=\fIKERNEL_NAME\fR;\ default="python3"\ \fB\-\-accelerator\-count\fR=\fIACCELERATOR_COUNT\fR\ \fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR\ \fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR;\ default="e2\-standard\-4"\ \fB\-\-disk\-size\-gb\fR=\fIDISK_SIZE_GB\fR;\ default=100\ \fB\-\-disk\-type\fR=\fIDISK_TYPE\fR;\ default=\f5"PD_STANDARD"\fR\ \fB\-\-no\-enable\-internet\-access\fR\ \fB\-\-network\fR=\fINETWORK\fR\ [\fB\-\-subnetwork\fR=\fISUBNETWORK\fR\ :\ \fB\-\-subnetwork\-region\fR=\fISUBNETWORK_REGION\fR]\ [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR]) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Create a Workbench notebook execution.



.SH "EXAMPLES"

To create an execution of a notebook file with Cloud Storage URI
\f5gs://my\-bucket/my\-notebook.ipynb\fR, with an execution job display name
\f5my\-execution\fR, running with service account
\f5my\-service\-account@my\-project.iam.gserviceaccount.com\fR, with results
uploaded to Cloud Storage bucket \f5gs://my\-bucket/results\fR, and in region
\f5us\-central1\fR, with a compute configuration of \f5n1\-standard\-4\fR
machine type:

.RS 2m
$ gcloud beta workbench executions create \e
     \-\-display\-name=my\-execution \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 \e
     \-\-region=us\-central1 \-\-machine\-type=n1\-standard\-4
.RE



.SH "REQUIRED 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
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
\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.
.RE
.sp

.RE
.sp
.TP 2m

Configuration of the execution job.

This must be specified.


.RS 2m
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_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
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR

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.

.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
\fB\-\-kernel\-name\fR=\fIKERNEL_NAME\fR; default="python3"

The kernel name to use for the execution.

.TP 2m

Source of the notebook to execute.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-direct\-content\fR=\fIDIRECT_CONTENT\fR

The direct notebook content as IPYNB. This can be a local filepath to an .ipynb
file or can be set to \f5\-\fR to read content from stdin.

.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

Compute configuration of the execution job.


.RS 2m
.TP 2m

The machine configuration of the runtime.


.RS 2m
.TP 2m
\fB\-\-accelerator\-count\fR=\fIACCELERATOR_COUNT\fR

The number of accelerators used by the runtime.

.TP 2m
\fB\-\-accelerator\-type\fR=\fIACCELERATOR_TYPE\fR

The type of hardware accelerator used by the runtime. If specified,
\-\-accelerator\-count must also be specified. \fIACCELERATOR_TYPE\fR must be
one of: \fBNVIDIA_TESLA_V100\fR, \fBNVIDIA_TESLA_T4\fR, \fBNVIDIA_TESLA_A100\fR,
\fBNVIDIA_A100_80GB\fR, \fBNVIDIA_L4\fR.

.TP 2m
\fB\-\-machine\-type\fR=\fIMACHINE_TYPE\fR; default="e2\-standard\-4"

The Compute Engine machine type selected for the runtime.

.RE
.sp
.TP 2m

The configuration for the data disk of the runtime.


.RS 2m
.TP 2m
\fB\-\-disk\-size\-gb\fR=\fIDISK_SIZE_GB\fR; 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.

.TP 2m
\fB\-\-disk\-type\fR=\fIDISK_TYPE\fR; default=\f5"PD_STANDARD"\fR

The type of the persistent disk. \fIDISK_TYPE\fR must be one of:
\fBPD_STANDARD\fR, \fBPD_SSD\fR, \fBPD_BALANCED\fR, \fBPD_EXTREME\fR.

.RE
.sp
.TP 2m

The network configuration for the runtime.


.RS 2m
.TP 2m
\fB\-\-enable\-internet\-access\fR

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

.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-network\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

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

To set the \f5network\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-network\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-subnetwork\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-subnetwork\fR=\fISUBNETWORK\fR

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

To set the \f5subnetwork\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-subnetwork\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-subnetwork\-region\fR=\fISUBNETWORK_REGION\fR

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

To set the \f5subnetwork\-region\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-subnetwork\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-subnetwork\-region\fR on the command line.
.RE
.sp

.RE
.RE
.RE
.sp
.TP 2m

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.


.RS 2m
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

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

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

KMS keyring id of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

Cloud project id for the key.

To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-project\fR on the command line.
.RE
.sp


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.


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