.TH "GCLOUD_DATAPLEX_ENVIRONMENTS_UPDATE" 1



.SH "NAME"
.HP
gcloud dataplex environments update \- update a Dataplex Environment with the given configurations



.SH "SYNOPSIS"
.HP
\f5gcloud dataplex environments update\fR (\fIENVIRONMENT\fR\ :\ \fB\-\-lake\fR=\fILAKE\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-async\fR\ |\ \fB\-\-validate\-only\fR] [\fB\-\-compute\-disk\-size\-gb\fR=\fICOMPUTE_DISK_SIZE_GB\fR\ \fB\-\-compute\-max\-node\-count\fR=\fICOMPUTE_MAX_NODE_COUNT\fR\ \fB\-\-compute\-node\-count\fR=\fICOMPUTE_NODE_COUNT\fR\ \fB\-\-os\-image\-java\-libraries\fR=[\fIOS_IMAGE_JAVA_LIBRARIES\fR,...]\ \fB\-\-os\-image\-properties\fR=[\fIOS_IMAGE_PROPERTIES\fR,...]\ \fB\-\-os\-image\-python\-packages\fR=[\fIOS_IMAGE_PYTHON_PACKAGES\fR,...]\ \fB\-\-os\-image\-version\fR=\fIOS_IMAGE_VERSION\fR] [\fB\-\-session\-enable\-fast\-startup\fR\ \fB\-\-session\-max\-idle\-duration\fR=\fISESSION_MAX_IDLE_DURATION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Dataplex Environment with the given configurations.



.SH "EXAMPLES"

To update a Dataplex environment \f5test\-environment\fR within lake
\f5test\-lake\fR in location \f5us\-central1\fR and change the description to
\f5Updated Description\fR, run:

.RS 2m
$ gcloud dataplex environments update test\-environment \e
    \-\-project=test\-project \-\-location=us\-central1 \-\-lake=test\-lake \e
    \-\-description='Updated Description'
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Environments resource \- The Environment to update a Environment to. 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 \f5environment\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
\fIENVIRONMENT\fR

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

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\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\-\-lake\fR=\fILAKE\fR

The identifier of the Dataplex lake resource.

To set the \f5lake\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-lake\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Dataplex resource.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\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 \f5dataplex/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the Environment

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

Display Name of the Environment

.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

At most one of \-\-async | \-\-validate\-only can be specified.

At most one of these can be specified:


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

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

.TP 2m
\fB\-\-validate\-only\fR

Validate the create action, but don't actually perform it.

.RE
.sp
.TP 2m

Configuration for the underlying infrastructure used to run workloads.


.RS 2m
.TP 2m

Compute resources associated with the analyze interactive workloads.


.RS 2m
.TP 2m
\fB\-\-compute\-disk\-size\-gb\fR=\fICOMPUTE_DISK_SIZE_GB\fR

Size in GB of the disk. Default is 100 GB.

.TP 2m
\fB\-\-compute\-max\-node\-count\fR=\fICOMPUTE_MAX_NODE_COUNT\fR

Maximum number of configurable nodes.

.TP 2m
\fB\-\-compute\-node\-count\fR=\fICOMPUTE_NODE_COUNT\fR

Total number of worker nodes in the cluster.

.RE
.sp
.TP 2m

Software Runtime Configuration to run Analyze.


.RS 2m
.TP 2m
\fB\-\-os\-image\-java\-libraries\fR=[\fIOS_IMAGE_JAVA_LIBRARIES\fR,...]

List of Java jars to be included in the runtime environment. Valid input
includes Cloud Storage URIs to Jar binaries. For example,
gs://bucket\-name/my/path/to/file.jar

.TP 2m
\fB\-\-os\-image\-properties\fR=[\fIOS_IMAGE_PROPERTIES\fR,...]

Override to common configuration of open source components installed on the
Dataproc cluster. The properties to set on daemon config files. Property keys
are specified in \f5prefix:property\fR format.

.TP 2m
\fB\-\-os\-image\-python\-packages\fR=[\fIOS_IMAGE_PYTHON_PACKAGES\fR,...]

A list of python packages to be installed. Valid formats include Cloud Storage
URI to a PIP installable library. For example,
gs://bucket\-name/my/path/to/lib.tar.gz

.TP 2m
\fB\-\-os\-image\-version\fR=\fIOS_IMAGE_VERSION\fR

Dataplex Image version.

.RE
.RE
.sp
.TP 2m

Configuration for sessions created for the environment to be updated.


.RS 2m
.TP 2m
\fB\-\-session\-enable\-fast\-startup\fR

Enables fast startup. This causes sessions to be pre\-created and available for
faster startup to enable interactive exploration use\-cases.

.TP 2m
\fB\-\-session\-max\-idle\-duration\fR=\fISESSION_MAX_IDLE_DURATION\fR

The idle time configuration of the session. The session will be auto\-terminated
at the end of this period.


.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 variant is also available:

.RS 2m
$ gcloud alpha dataplex environments update
.RE