environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	google.dataplex.environments

Fields

The following fields are returned by SELECT queries:

projects_locations_lakes_environments_get

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
createTime	string (google-datetime)	Output only. Environment creation time.
description	string	Optional. Description of the environment.
displayName	string	Optional. User friendly display name.
endpoints	object	Output only. URI Endpoints to access sessions associated with the Environment. (id: GoogleCloudDataplexV1EnvironmentEndpoints)
infrastructureSpec	object	Required. Infrastructure specification for the Environment. (id: GoogleCloudDataplexV1EnvironmentInfrastructureSpec)
labels	object	Optional. User defined labels for the environment.
sessionSpec	object	Optional. Configuration for sessions created for this environment. (id: GoogleCloudDataplexV1EnvironmentSessionSpec)
sessionStatus	object	Output only. Status of sessions created for this environment. (id: GoogleCloudDataplexV1EnvironmentSessionStatus)
state	string	Output only. Current state of the environment.
uid	string	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.
updateTime	string (google-datetime)	Output only. The time when the environment was last updated.

projects_locations_lakes_environments_list

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
createTime	string (google-datetime)	Output only. Environment creation time.
description	string	Optional. Description of the environment.
displayName	string	Optional. User friendly display name.
endpoints	object	Output only. URI Endpoints to access sessions associated with the Environment. (id: GoogleCloudDataplexV1EnvironmentEndpoints)
infrastructureSpec	object	Required. Infrastructure specification for the Environment. (id: GoogleCloudDataplexV1EnvironmentInfrastructureSpec)
labels	object	Optional. User defined labels for the environment.
sessionSpec	object	Optional. Configuration for sessions created for this environment. (id: GoogleCloudDataplexV1EnvironmentSessionSpec)
sessionStatus	object	Output only. Status of sessions created for this environment. (id: GoogleCloudDataplexV1EnvironmentSessionStatus)
state	string	Output only. Current state of the environment.
uid	string	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.
updateTime	string (google-datetime)	Output only. The time when the environment was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_lakes_environments_get	select	projectsId, locationsId, lakesId, environmentsId		Get environment resource.
projects_locations_lakes_environments_list	select	projectsId, locationsId, lakesId	pageSize, pageToken, filter, orderBy	Lists environments under the given lake.
projects_locations_lakes_environments_create	insert	projectsId, locationsId, lakesId	environmentId, validateOnly	Create an environment resource.
projects_locations_lakes_environments_patch	update	projectsId, locationsId, lakesId, environmentsId	updateMask, validateOnly	Update the environment resource.
projects_locations_lakes_environments_delete	delete	projectsId, locationsId, lakesId, environmentsId		Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentsId	string
lakesId	string
locationsId	string
projectsId	string
environmentId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_lakes_environments_get

Get environment resource.

SELECT
name,
createTime,
description,
displayName,
endpoints,
infrastructureSpec,
labels,
sessionSpec,
sessionStatus,
state,
uid,
updateTime
FROM google.dataplex.environments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

projects_locations_lakes_environments_list

Lists environments under the given lake.

SELECT
name,
createTime,
description,
displayName,
endpoints,
infrastructureSpec,
labels,
sessionSpec,
sessionStatus,
state,
uid,
updateTime
FROM google.dataplex.environments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND lakesId = '{{ lakesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_lakes_environments_create

Create an environment resource.

INSERT INTO google.dataplex.environments (
data__displayName,
data__labels,
data__description,
data__infrastructureSpec,
data__sessionSpec,
projectsId,
locationsId,
lakesId,
environmentId,
validateOnly
)
SELECT 
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
'{{ infrastructureSpec }}',
'{{ sessionSpec }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ lakesId }}',
'{{ environmentId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: environments
  props:
    - name: projectsId
      value: string
      description: Required parameter for the environments resource.
    - name: locationsId
      value: string
      description: Required parameter for the environments resource.
    - name: lakesId
      value: string
      description: Required parameter for the environments resource.
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User defined labels for the environment.
        
    - name: description
      value: string
      description: >
        Optional. Description of the environment.
        
    - name: infrastructureSpec
      value: object
      description: >
        Required. Infrastructure specification for the Environment.
        
    - name: sessionSpec
      value: object
      description: >
        Optional. Configuration for sessions created for this environment.
        
    - name: environmentId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_lakes_environments_patch

Update the environment resource.

UPDATE google.dataplex.environments
SET 
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__infrastructureSpec = '{{ infrastructureSpec }}',
data__sessionSpec = '{{ sessionSpec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lakesId = '{{ lakesId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_lakes_environments_delete

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

DELETE FROM google.dataplex.environments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lakesId = '{{ lakesId }}' --required
AND environmentsId = '{{ environmentsId }}' --required;