google-native.dataplex/v1.getEnvironment
Get environment resource.
Using getEnvironment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
def get_environment(environment_id: Optional[str] = None,
lake_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
lake_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
> Note: This function is named LookupEnvironment
in the Go SDK.
public static class GetEnvironment
{
public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:dataplex/v1:getEnvironment
arguments:
# arguments dictionary
The following arguments are supported:
- Environment
Id string - Lake
Id string - Location string
- Project string
- Environment
Id string - Lake
Id string - Location string
- Project string
- environment
Id String - lake
Id String - location String
- project String
- environment
Id string - lake
Id string - location string
- project string
- environment_
id str - lake_
id str - location str
- project str
- environment
Id String - lake
Id String - location String
- project String
getEnvironment Result
The following output properties are available:
- Create
Time string Environment creation time.
- Description string
Optional. Description of the environment.
- Display
Name string Optional. User friendly display name.
- Endpoints
Pulumi.
Google Native. Dataplex. V1. Outputs. Google Cloud Dataplex V1Environment Endpoints Response URI Endpoints to access sessions associated with the Environment.
- Infrastructure
Spec Pulumi.Google Native. Dataplex. V1. Outputs. Google Cloud Dataplex V1Environment Infrastructure Spec Response Infrastructure specification for the Environment.
- Labels Dictionary<string, string>
Optional. User defined labels for the environment.
- Name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- Session
Spec Pulumi.Google Native. Dataplex. V1. Outputs. Google Cloud Dataplex V1Environment Session Spec Response Optional. Configuration for sessions created for this environment.
- Session
Status Pulumi.Google Native. Dataplex. V1. Outputs. Google Cloud Dataplex V1Environment Session Status Response Status of sessions created for this environment.
- State string
Current state of the environment.
- Uid string
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 string The time when the environment was last updated.
- Create
Time string Environment creation time.
- Description string
Optional. Description of the environment.
- Display
Name string Optional. User friendly display name.
- Endpoints
Google
Cloud Dataplex V1Environment Endpoints Response URI Endpoints to access sessions associated with the Environment.
- Infrastructure
Spec GoogleCloud Dataplex V1Environment Infrastructure Spec Response Infrastructure specification for the Environment.
- Labels map[string]string
Optional. User defined labels for the environment.
- Name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- Session
Spec GoogleCloud Dataplex V1Environment Session Spec Response Optional. Configuration for sessions created for this environment.
- Session
Status GoogleCloud Dataplex V1Environment Session Status Response Status of sessions created for this environment.
- State string
Current state of the environment.
- Uid string
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 string The time when the environment was last updated.
- create
Time String Environment creation time.
- description String
Optional. Description of the environment.
- display
Name String Optional. User friendly display name.
- endpoints
Google
Cloud Dataplex V1Environment Endpoints Response URI Endpoints to access sessions associated with the Environment.
- infrastructure
Spec GoogleCloud Dataplex V1Environment Infrastructure Spec Response Infrastructure specification for the Environment.
- labels Map<String,String>
Optional. User defined labels for the environment.
- name String
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- session
Spec GoogleCloud Dataplex V1Environment Session Spec Response Optional. Configuration for sessions created for this environment.
- session
Status GoogleCloud Dataplex V1Environment Session Status Response Status of sessions created for this environment.
- state String
Current state of the environment.
- uid String
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 String The time when the environment was last updated.
- create
Time string Environment creation time.
- description string
Optional. Description of the environment.
- display
Name string Optional. User friendly display name.
- endpoints
Google
Cloud Dataplex V1Environment Endpoints Response URI Endpoints to access sessions associated with the Environment.
- infrastructure
Spec GoogleCloud Dataplex V1Environment Infrastructure Spec Response Infrastructure specification for the Environment.
- labels {[key: string]: string}
Optional. User defined labels for the environment.
- name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- session
Spec GoogleCloud Dataplex V1Environment Session Spec Response Optional. Configuration for sessions created for this environment.
- session
Status GoogleCloud Dataplex V1Environment Session Status Response Status of sessions created for this environment.
- state string
Current state of the environment.
- uid string
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 string The time when the environment was last updated.
- create_
time str Environment creation time.
- description str
Optional. Description of the environment.
- display_
name str Optional. User friendly display name.
- endpoints
Google
Cloud Dataplex V1Environment Endpoints Response URI Endpoints to access sessions associated with the Environment.
- infrastructure_
spec GoogleCloud Dataplex V1Environment Infrastructure Spec Response Infrastructure specification for the Environment.
- labels Mapping[str, str]
Optional. User defined labels for the environment.
- name str
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- session_
spec GoogleCloud Dataplex V1Environment Session Spec Response Optional. Configuration for sessions created for this environment.
- session_
status GoogleCloud Dataplex V1Environment Session Status Response Status of sessions created for this environment.
- state str
Current state of the environment.
- uid str
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 str The time when the environment was last updated.
- create
Time String Environment creation time.
- description String
Optional. Description of the environment.
- display
Name String Optional. User friendly display name.
- endpoints Property Map
URI Endpoints to access sessions associated with the Environment.
- infrastructure
Spec Property Map Infrastructure specification for the Environment.
- labels Map<String>
Optional. User defined labels for the environment.
- name String
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
- session
Spec Property Map Optional. Configuration for sessions created for this environment.
- session
Status Property Map Status of sessions created for this environment.
- state String
Current state of the environment.
- uid String
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 String The time when the environment was last updated.
Supporting Types
GoogleCloudDataplexV1EnvironmentEndpointsResponse
GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
- Disk
Size intGb Optional. Size in GB of the disk. Default is 100 GB.
- Max
Node intCount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- Node
Count int Optional. Total number of nodes in the sessions created for this environment.
- Disk
Size intGb Optional. Size in GB of the disk. Default is 100 GB.
- Max
Node intCount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- Node
Count int Optional. Total number of nodes in the sessions created for this environment.
- disk
Size IntegerGb Optional. Size in GB of the disk. Default is 100 GB.
- max
Node IntegerCount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- node
Count Integer Optional. Total number of nodes in the sessions created for this environment.
- disk
Size numberGb Optional. Size in GB of the disk. Default is 100 GB.
- max
Node numberCount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- node
Count number Optional. Total number of nodes in the sessions created for this environment.
- disk_
size_ intgb Optional. Size in GB of the disk. Default is 100 GB.
- max_
node_ intcount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- node_
count int Optional. Total number of nodes in the sessions created for this environment.
- disk
Size NumberGb Optional. Size in GB of the disk. Default is 100 GB.
- max
Node NumberCount Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
- node
Count Number Optional. Total number of nodes in the sessions created for this environment.
GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
- Image
Version string Dataplex Image version.
- Java
Libraries List<string> 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
- Properties Dictionary<string, string>
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 prefix:property format. The prefix must be "spark".
- Python
Packages List<string> 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
- Image
Version string Dataplex Image version.
- Java
Libraries []string 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
- Properties map[string]string
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 prefix:property format. The prefix must be "spark".
- Python
Packages []string 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
- image
Version String Dataplex Image version.
- java
Libraries List<String> 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
- properties Map<String,String>
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 prefix:property format. The prefix must be "spark".
- python
Packages List<String> 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
- image
Version string Dataplex Image version.
- java
Libraries string[] 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
- properties {[key: string]: string}
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 prefix:property format. The prefix must be "spark".
- python
Packages string[] 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
- image_
version str Dataplex Image version.
- java_
libraries Sequence[str] 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
- properties Mapping[str, str]
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 prefix:property format. The prefix must be "spark".
- python_
packages Sequence[str] 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
- image
Version String Dataplex Image version.
- java
Libraries List<String> 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
- properties Map<String>
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 prefix:property format. The prefix must be "spark".
- python
Packages List<String> 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
GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
- Compute
Pulumi.
Google Native. Dataplex. V1. Inputs. Google Cloud Dataplex V1Environment Infrastructure Spec Compute Resources Response Optional. Compute resources needed for analyze interactive workloads.
- Os
Image Pulumi.Google Native. Dataplex. V1. Inputs. Google Cloud Dataplex V1Environment Infrastructure Spec Os Image Runtime Response Software Runtime Configuration for analyze interactive workloads.
- Compute
Google
Cloud Dataplex V1Environment Infrastructure Spec Compute Resources Response Optional. Compute resources needed for analyze interactive workloads.
- Os
Image GoogleCloud Dataplex V1Environment Infrastructure Spec Os Image Runtime Response Software Runtime Configuration for analyze interactive workloads.
- compute
Google
Cloud Dataplex V1Environment Infrastructure Spec Compute Resources Response Optional. Compute resources needed for analyze interactive workloads.
- os
Image GoogleCloud Dataplex V1Environment Infrastructure Spec Os Image Runtime Response Software Runtime Configuration for analyze interactive workloads.
- compute
Google
Cloud Dataplex V1Environment Infrastructure Spec Compute Resources Response Optional. Compute resources needed for analyze interactive workloads.
- os
Image GoogleCloud Dataplex V1Environment Infrastructure Spec Os Image Runtime Response Software Runtime Configuration for analyze interactive workloads.
- compute
Google
Cloud Dataplex V1Environment Infrastructure Spec Compute Resources Response Optional. Compute resources needed for analyze interactive workloads.
- os_
image GoogleCloud Dataplex V1Environment Infrastructure Spec Os Image Runtime Response Software Runtime Configuration for analyze interactive workloads.
- compute Property Map
Optional. Compute resources needed for analyze interactive workloads.
- os
Image Property Map Software Runtime Configuration for analyze interactive workloads.
GoogleCloudDataplexV1EnvironmentSessionSpecResponse
- Enable
Fast boolStartup 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 stringDuration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
- Enable
Fast boolStartup 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 stringDuration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
- enable
Fast BooleanStartup 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 StringDuration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
- enable
Fast booleanStartup 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 stringDuration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
- enable_
fast_ boolstartup 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_ strduration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
- enable
Fast BooleanStartup 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 StringDuration Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
GoogleCloudDataplexV1EnvironmentSessionStatusResponse
- Active bool
Queries over sessions to mark whether the environment is currently active or not
- Active bool
Queries over sessions to mark whether the environment is currently active or not
- active Boolean
Queries over sessions to mark whether the environment is currently active or not
- active boolean
Queries over sessions to mark whether the environment is currently active or not
- active bool
Queries over sessions to mark whether the environment is currently active or not
- active Boolean
Queries over sessions to mark whether the environment is currently active or not
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0