lakes

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

Overview

Name	lakes
Type	Resource
Id	google.dataplex.lakes

Fields

Name	Datatype	Description
name	string	Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
description	string	Optional. Description of the lake.
assetStatus	object	Aggregated status of the underlying assets of a lake or zone.
createTime	string	Output only. The time when the lake was created.
displayName	string	Optional. User friendly display name.
labels	object	Optional. User-defined labels for the lake.
metastore	object	Settings to manage association of Dataproc Metastore with a lake.
metastoreStatus	object	Status of Lake and Dataproc Metastore service instance association.
serviceAccount	string	Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state	string	Output only. Current state of the lake.
uid	string	Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime	string	Output only. The time when the lake was last updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_lakes_get	SELECT	lakesId, locationsId, projectsId	Retrieves a lake resource.
projects_locations_lakes_list	SELECT	locationsId, projectsId	Lists lake resources in a project and location.
projects_locations_lakes_create	INSERT	locationsId, projectsId	Creates a lake resource.
projects_locations_lakes_delete	DELETE	lakesId, locationsId, projectsId	Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
projects_locations_lakes_patch	UPDATE	lakesId, locationsId, projectsId	Updates a lake resource.

SELECT examples

Lists lake resources in a project and location.

SELECT
name,
description,
assetStatus,
createTime,
displayName,
labels,
metastore,
metastoreStatus,
serviceAccount,
state,
uid,
updateTime
FROM google.dataplex.lakes
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.dataplex.lakes (
locationsId,
projectsId,
displayName,
labels,
description,
metastore
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
'{{ metastore }}'
;

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: serviceAccount
      value: string
    - name: metastore
      value:
        - name: service
          value: string
    - name: assetStatus
      value:
        - name: updateTime
          value: string
        - name: activeAssets
          value: integer
        - name: securityPolicyApplyingAssets
          value: integer
    - name: metastoreStatus
      value:
        - name: state
          value: string
        - name: message
          value: string
        - name: updateTime
          value: string
        - name: endpoint
          value: string

UPDATE example

Updates a lakes resource.

/*+ update */
UPDATE google.dataplex.lakes
SET 
displayName = '{{ displayName }}',
labels = '{{ labels }}',
description = '{{ description }}',
metastore = '{{ metastore }}'
WHERE 
lakesId = '{{ lakesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified lakes resource.

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