lakes

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

Overview

Name	lakes
Type	Resource
Id	google.dataplex.lakes

Fields

The following fields are returned by SELECT queries:

projects_locations_lakes_get

Successful response

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}.
assetStatus	object	Output only. Aggregated status of the underlying assets of the lake. (id: GoogleCloudDataplexV1AssetStatus)
createTime	string (google-datetime)	Output only. The time when the lake was created.
description	string	Optional. Description of the lake.
displayName	string	Optional. User friendly display name.
labels	object	Optional. User-defined labels for the lake.
metastore	object	Optional. Settings to manage lake and Dataproc Metastore service instance association. (id: GoogleCloudDataplexV1LakeMetastore)
metastoreStatus	object	Output only. Metastore status of the lake. (id: GoogleCloudDataplexV1LakeMetastoreStatus)
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 (google-datetime)	Output only. The time when the lake was last updated.

projects_locations_lakes_list

Successful response

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}.
assetStatus	object	Output only. Aggregated status of the underlying assets of the lake. (id: GoogleCloudDataplexV1AssetStatus)
createTime	string (google-datetime)	Output only. The time when the lake was created.
description	string	Optional. Description of the lake.
displayName	string	Optional. User friendly display name.
labels	object	Optional. User-defined labels for the lake.
metastore	object	Optional. Settings to manage lake and Dataproc Metastore service instance association. (id: GoogleCloudDataplexV1LakeMetastore)
metastoreStatus	object	Output only. Metastore status of the lake. (id: GoogleCloudDataplexV1LakeMetastoreStatus)
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 (google-datetime)	Output only. The time when the lake was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_lakes_get	select	projectsId, locationsId, lakesId		Retrieves a lake resource.
projects_locations_lakes_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists lake resources in a project and location.
projects_locations_lakes_create	insert	projectsId, locationsId	lakeId, validateOnly	Creates a lake resource.
projects_locations_lakes_patch	update	projectsId, locationsId, lakesId	updateMask, validateOnly	Updates a lake resource.
projects_locations_lakes_delete	delete	projectsId, locationsId, lakesId		Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

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
lakesId	string
locationsId	string
projectsId	string
filter	string
lakeId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_lakes_get

Retrieves a lake resource.

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

projects_locations_lakes_list

Lists lake resources in a project and location.

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

INSERT examples

projects_locations_lakes_create

Creates a lake resource.

INSERT INTO google.dataplex.lakes (
data__displayName,
data__labels,
data__description,
data__metastore,
projectsId,
locationsId,
lakeId,
validateOnly
)
SELECT 
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
'{{ metastore }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ lakeId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: lakes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the lakes resource.
    - name: locationsId
      value: string
      description: Required parameter for the lakes resource.
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the lake.
        
    - name: description
      value: string
      description: >
        Optional. Description of the lake.
        
    - name: metastore
      value: object
      description: >
        Optional. Settings to manage lake and Dataproc Metastore service instance association.
        
    - name: lakeId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_lakes_patch

Updates a lake resource.

UPDATE google.dataplex.lakes
SET 
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__metastore = '{{ metastore }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND lakesId = '{{ lakesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_lakes_delete

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

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