environments

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

Overview

Name	environments
Type	Resource
Id	google.dataplex.environments

Fields

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}
description	string	Optional. Description of the environment.
createTime	string	Output only. Environment creation time.
displayName	string	Optional. User friendly display name.
endpoints	object	URI Endpoints to access sessions associated with the Environment.
infrastructureSpec	object	Configuration for the underlying infrastructure used to run workloads.
labels	object	Optional. User defined labels for the environment.
sessionSpec	object	Configuration for sessions created for this environment.
sessionStatus	object	Status of sessions created for this environment.
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	Output only. The time when the environment was last updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_lakes_environments_get	SELECT	environmentsId, lakesId, locationsId, projectsId	Get environment resource.
projects_locations_lakes_environments_list	SELECT	lakesId, locationsId, projectsId	Lists environments under the given lake.
projects_locations_lakes_environments_create	INSERT	lakesId, locationsId, projectsId	Create an environment resource.
projects_locations_lakes_environments_delete	DELETE	environmentsId, lakesId, locationsId, projectsId	Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
projects_locations_lakes_environments_patch	UPDATE	environmentsId, lakesId, locationsId, projectsId	Update the environment resource.

SELECT examples

Lists environments under the given lake.

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

INSERT example

Use the following StackQL query and manifest file to create a new environments resource.

All Properties

/*+ create */
INSERT INTO google.dataplex.environments (
lakesId,
locationsId,
projectsId,
displayName,
labels,
description,
infrastructureSpec,
sessionSpec
)
SELECT 
'{{ lakesId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
'{{ infrastructureSpec }}',
'{{ sessionSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: state
      value: string
    - name: infrastructureSpec
      value:
        - name: compute
          value:
            - name: diskSizeGb
              value: integer
            - name: nodeCount
              value: integer
            - name: maxNodeCount
              value: integer
        - name: osImage
          value:
            - name: imageVersion
              value: string
            - name: javaLibraries
              value:
                - string
            - name: pythonPackages
              value:
                - string
            - name: properties
              value: object
    - name: sessionSpec
      value:
        - name: maxIdleDuration
          value: string
        - name: enableFastStartup
          value: boolean
    - name: sessionStatus
      value:
        - name: active
          value: boolean
    - name: endpoints
      value:
        - name: notebooks
          value: string
        - name: sql
          value: string

UPDATE example

Updates a environments resource.

/*+ update */
UPDATE google.dataplex.environments
SET 
displayName = '{{ displayName }}',
labels = '{{ labels }}',
description = '{{ description }}',
infrastructureSpec = '{{ infrastructureSpec }}',
sessionSpec = '{{ sessionSpec }}'
WHERE 
environmentsId = '{{ environmentsId }}'
AND lakesId = '{{ lakesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified environments resource.

/*+ delete */
DELETE FROM google.dataplex.environments
WHERE environmentsId = '{{ environmentsId }}'
AND lakesId = '{{ lakesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';