- Resource: Environment
- InfrastructureSpec
- ComputeResources
- OsImageRuntime
- SessionSpec
- SessionStatus
- Endpoints
- Methods
Resource: Environment
Environment represents a user-visible compute infrastructure for analytics within a lake.
JSON representation |
---|
{ "name": string, "displayName": string, "uid": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "description": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The relative resource name of the environment, of the form: projects/{projectId}/locations/{locationId}/lakes/{lakeId}/environment/{environmentId} |
displayName |
Optional. User friendly display name. |
uid |
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. |
createTime |
Output only. Environment creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time when the environment was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. User defined labels for the environment. An object containing a list of |
description |
Optional. Description of the environment. |
state |
Output only. Current state of the environment. |
infrastructureSpec |
Required. Infrastructure specification for the Environment. |
sessionSpec |
Optional. Configuration for sessions created for this environment. |
sessionStatus |
Output only. Status of sessions created for this environment. |
endpoints |
Output only. URI Endpoints to access sessions associated with the Environment. |
InfrastructureSpec
Configuration for the underlying infrastructure used to run workloads.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field resources . Hardware config resources can be only one of the following: |
|
compute |
Optional. Compute resources needed for analyze interactive workloads. |
Union field runtime . Software config runtime can be only one of the following: |
|
osImage |
Required. Software Runtime Configuration for analyze interactive workloads. |
ComputeResources
Compute resources associated with the analyze interactive workloads.
JSON representation |
---|
{ "diskSizeGb": integer, "nodeCount": integer, "maxNodeCount": integer } |
Fields | |
---|---|
diskSizeGb |
Optional. Size in GB of the disk. Default is 100 GB. |
nodeCount |
Optional. Total number of nodes in the sessions created for this environment. |
maxNodeCount |
Optional. Max configurable nodes. If maxNodeCount > nodeCount, then auto-scaling is enabled. |
OsImageRuntime
Software Runtime Configuration to run Analyze.
JSON representation |
---|
{ "imageVersion": string, "javaLibraries": [ string ], "pythonPackages": [ string ], "properties": { string: string, ... } } |
Fields | |
---|---|
imageVersion |
Required. Dataplex Image version. |
javaLibraries[] |
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 |
pythonPackages[] |
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 |
properties |
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in An object containing a list of |
SessionSpec
Configuration for sessions created for this environment.
JSON representation |
---|
{ "maxIdleDuration": string, "enableFastStartup": boolean } |
Fields | |
---|---|
maxIdleDuration |
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period. A duration in seconds with up to nine fractional digits, ending with ' |
enableFastStartup |
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. |
SessionStatus
Status of sessions created for this environment.
JSON representation |
---|
{ "active": boolean } |
Fields | |
---|---|
active |
Output only. Queries over sessions to mark whether the environment is currently active or not |
Endpoints
URI Endpoints to access sessions associated with the Environment.
JSON representation |
---|
{ "notebooks": string, "sql": string } |
Fields | |
---|---|
notebooks |
Output only. URI to serve notebook APIs |
sql |
Output only. URI to serve SQL APIs |
Methods |
|
---|---|
|
Create an environment resource. |
|
Delete the environment resource. |
|
Get environment resource. |
|
Gets the access control policy for a resource. |
|
Lists environments under the given lake. |
|
Update the environment resource. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |