File: //snap/google-cloud-cli/396/help/man/man1/gcloud_beta_dataproc_sessions_create_spark.1
.TH "GCLOUD_BETA_DATAPROC_SESSIONS_CREATE_SPARK" 1
.SH "NAME"
.HP
gcloud beta dataproc sessions create spark \- create a Spark session
.SH "SYNOPSIS"
.HP
\f5gcloud beta dataproc sessions create spark\fR (\fISESSION\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-container\-image\fR=\fICONTAINER_IMAGE\fR] [\fB\-\-history\-server\-cluster\fR=\fIHISTORY_SERVER_CLUSTER\fR] [\fB\-\-kernel\fR=\fIKERNEL\fR] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-max\-idle\fR=\fIMAX_IDLE\fR] [\fB\-\-metastore\-service\fR=\fIMETASTORE_SERVICE\fR] [\fB\-\-property\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]] [\fB\-\-request\-id\fR=\fIREQUEST_ID\fR] [\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR] [\fB\-\-session_template\fR=\fISESSION_TEMPLATE\fR] [\fB\-\-staging\-bucket\fR=\fISTAGING_BUCKET\fR] [\fB\-\-tags\fR=[\fITAGS\fR,...]] [\fB\-\-ttl\fR=\fITTL\fR] [\fB\-\-user\-workload\-authentication\-type\fR=\fIUSER_WORKLOAD_AUTHENTICATION_TYPE\fR] [\fB\-\-version\fR=\fIVERSION\fR] [\fB\-\-network\fR=\fINETWORK\fR\ |\ \fB\-\-subnet\fR=\fISUBNET\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(BETA)\fR Create a Spark session.
.SH "EXAMPLES"
To create a Spark session, to:
.RS 2m
$ gcloud beta dataproc sessions create spark my\-session \e
\-\-location=us\-central1
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Session resource \- ID of the session to create. 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 \f5session\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
\fISESSION\fR
ID of the session or fully qualified identifier for the session.
To set the \f5session\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5session\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\-\-location\fR=\fILOCATION\fR
Dataproc location for the session. Each Dataproc location constitutes an
independent resource namespace constrained to deploying instances into Compute
Engine zones inside the location. Overrides the default \f5dataproc/location\fR
property value for this command invocation.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5session\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataproc/location\fR.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-container\-image\fR=\fICONTAINER_IMAGE\fR
Optional custom container image to use for the batch/session runtime
environment. If not specified, a default container image will be used. The value
should follow the container image naming format:
{registry}/{repository}/{name}:{tag}, for example,
gcr.io/my\-project/my\-image:1.2.3
.TP 2m
\fB\-\-history\-server\-cluster\fR=\fIHISTORY_SERVER_CLUSTER\fR
Spark History Server configuration for the batch/session job. Resource name of
an existing Dataproc cluster to act as a Spark History Server for the workload
in the format: "projects/{project_id}/regions/{region}/clusters/{cluster_name}".
.TP 2m
\fB\-\-kernel\fR=\fIKERNEL\fR
Jupyter kernel type. The value could be "python" or "scala". \fIKERNEL\fR must
be one of: \fBpython\fR, \fBscala\fR.
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR
Cloud KMS key to use for encryption.
.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.
.TP 2m
\fB\-\-max\-idle\fR=\fIMAX_IDLE\fR
The duration after which an idle session will be automatically terminated, for
example, "20m" or "2h". A session is considered idle if it has no active Spark
applications and no active Jupyter kernels. Run gcloud topic datetimes
(https://cloud.google.com/sdk/gcloud/reference/topic/datetimes) for information
on duration formats.
.TP 2m
\fB\-\-metastore\-service\fR=\fIMETASTORE_SERVICE\fR
Name of a Dataproc Metastore service to be used as an external metastore in the
format: "projects/{project\-id}/locations/{region}/services/{service\-name}".
.TP 2m
\fB\-\-property\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]
Specifies configuration properties.
.TP 2m
\fB\-\-request\-id\fR=\fIREQUEST_ID\fR
A unique ID that identifies the request. If the service receives two session
create requests with the same request_id, the second request is ignored and the
operation that corresponds to the first session created and stored in the
backend is returned. Recommendation: Always set this value to a UUID. The value
must contain only letters (a\-z, A\-Z), numbers (0\-9), underscores (\fI), and
hyphens (\-). The maximum length is 40 characters.
.TP 2m
\fB\-\-service\-account\fR=\fRSERVICE_ACCOUNT\fI
The IAM service account to be used for a batch/session job.
.TP 2m
\fB\-\-session_template\fR=\fRSESSION_TEMPLATE\fI
The session template to use for creating the session.
.TP 2m
\fB\-\-staging\-bucket\fR=\fRSTAGING_BUCKET\fI
The Cloud Storage bucket to use to store job dependencies, config files, and job
driver console output. If not specified, the default [staging bucket]
(https://cloud.google.com/dataproc\-serverless/docs/concepts/buckets) is used.
.TP 2m
\fB\-\-tags\fR=[\fRTAGS\fI,...]
Network tags for traffic control.
.TP 2m
\fB\-\-ttl\fR=\fRTTL\fI
The duration after the workload will be unconditionally terminated, for example,
\'20m' or '1h'. Run gcloud topic datetimes
(https://cloud.google.com/sdk/gcloud/reference/topic/datetimes) for information
on duration formats.
.TP 2m
\fB\-\-user\-workload\-authentication\-type\fR=\fRUSER_WORKLOAD_AUTHENTICATION_TYPE\fI
Whether to use END_USER_CREDENTIALS or SERVICE_ACCOUNT to run the workload.
.TP 2m
\fB\-\-version\fR=\fRVERSION\fI
Optional runtime version. If not specified, a default version will be used.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-network\fR=\fRNETWORK\fI
Network URI to connect network to.
.TP 2m
\fB\-\-subnet\fR=\fRSUBNET\fI
Subnetwork URI to connect network to. Subnet must have Private Google Access
enabled.
\fR
.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.