gcloud alpha dataplex environments update - update a Dataplex Environment with the given configurations
gcloud alpha dataplex environments update (ENVIRONMENT : --lake=LAKE --location=LOCATION) [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] [--async | --validate-only] [--compute-disk-size-gb=COMPUTE_DISK_SIZE_GB --compute-max-node-count=COMPUTE_MAX_NODE_COUNT --compute-node-count=COMPUTE_NODE_COUNT --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] --os-image-properties=[OS_IMAGE_PROPERTIES,...] --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] --os-image-version=OS_IMAGE_VERSION] [--session-enable-fast-startup --session-max-idle-duration=SESSION_MAX_IDLE_DURATION] [GCLOUD_WIDE_FLAG ...]
(ALPHA) Update a Dataplex Environment with the given configurations.
To update a Dataplex environment test-environment within lake test-lake in location us-central1 and change the description to Updated Description, run:
$ gcloud alpha dataplex environments update test-environment \ --project=test-project --location=us-central1 --lake=test-lake \ --description='Updated Description'
- 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 project attribute:
- —
provide the argument environment 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.
- ENVIRONMENT
ID of the environments or fully qualified identifier for the environments. To set the environment attribute:
provide the argument environment on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- --lake=LAKE
The identifier of the Dataplex lake resource. To set the lake attribute:
provide the argument environment on the command line with a fully specified name;
provide the argument --lake on the command line.
- --location=LOCATION
The location of the Dataplex resource. To set the location attribute:
provide the argument environment on the command line with a fully specified name;
provide the argument --location on the command line;
set the property dataplex/location.
- --description=DESCRIPTION
Description of the Environment
- --display-name=DISPLAY_NAME
Display Name of the Environment
- --labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
- At most one of --async | --validate-only can be specified.
At most one of these can be specified:
- --async
Return immediately, without waiting for the operation in progress to complete.
- --validate-only
Validate the create action, but don't actually perform it.
- Configuration for the underlying infrastructure used to run workloads.
- Compute resources associated with the analyze interactive workloads.
- --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB
Size in GB of the disk. Default is 100 GB.
- --compute-max-node-count=COMPUTE_MAX_NODE_COUNT
Maximum number of configurable nodes.
- --compute-node-count=COMPUTE_NODE_COUNT
Total number of worker nodes in the cluster.
- Software Runtime Configuration to run Analyze.
- --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...]
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
- --os-image-properties=[OS_IMAGE_PROPERTIES,...]
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 prefix:property format.
- --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...]
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
- --os-image-version=OS_IMAGE_VERSION
Dataplex Image version.
- Configuration for sessions created for the environment to be updated.
- --session-enable-fast-startup
Enables fast startup. This causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases.
- --session-max-idle-duration=SESSION_MAX_IDLE_DURATION
The idle time configuration of the session. The session will be auto-terminated at the end of this period.
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.
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:
$ gcloud dataplex environments update