gcp_dataplex_environment
ancestors
Type: UNORDERED_LIST_STRING
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Environment creation time.
description
Type: STRING
Provider name: description
Description: Optional. Description of the environment.
endpoints
Type: STRUCT
Provider name: endpoints
Description: Output only. URI Endpoints to access sessions associated with the Environment.
notebooks
Type: STRING
Provider name: notebooks
Description: Output only. URI to serve notebook APIs
sql
Type: STRING
Provider name: sql
Description: Output only. URI to serve SQL APIs
gcp_display_name
Type: STRING
Provider name: displayName
Description: Optional. User friendly display name.
infrastructure_spec
Type: STRUCT
Provider name: infrastructureSpec
Description: Required. Infrastructure specification for the Environment.
compute
Type: STRUCT
Provider name: compute
Description: Optional. Compute resources needed for analyze interactive workloads.
disk_size_gb
Type: INT32
Provider name: diskSizeGb
Description: Optional. Size in GB of the disk. Default is 100 GB.
max_node_count
Type: INT32
Provider name: maxNodeCount
Description: Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
node_count
Type: INT32
Provider name: nodeCount
Description: Optional. Total number of nodes in the sessions created for this environment.
os_image
Type: STRUCT
Provider name: osImage
Description: Required. Software Runtime Configuration for analyze interactive workloads.
image_version
Type: STRING
Provider name: imageVersion
Description: Required. Dataplex Image version.
java_libraries
Type: UNORDERED_LIST_STRING
Provider name: javaLibraries
Description: Optional. 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
python_packages
Type: UNORDERED_LIST_STRING
Provider name: pythonPackages
Description: Optional. 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
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
session_spec
Type: STRUCT
Provider name: sessionSpec
Description: Optional. Configuration for sessions created for this environment.
enable_fast_startup
Type: BOOLEAN
Provider name: enableFastStartup
Description: Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to “default”, and with default configuration.
max_idle_duration
Type: STRING
Provider name: maxIdleDuration
Description: Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
session_status
Type: STRUCT
Provider name: sessionStatus
Description: Output only. Status of sessions created for this environment.
active
Type: BOOLEAN
Provider name: active
Description: Output only. Queries over sessions to mark whether the environment is currently active or not
state
Type: STRING
Provider name: state
Description: Output only. Current state of the environment.
Possible values:
STATE_UNSPECIFIED
- State is not specified.
ACTIVE
- Resource is active, i.e., ready to use.
CREATING
- Resource is under creation.
DELETING
- Resource is under deletion.
ACTION_REQUIRED
- Resource is active but has unresolved actions.
Type: UNORDERED_LIST_STRING
uid
Type: STRING
Provider name: uid
Description: Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time when the environment was last updated.