REST Resource: projects.locations.lakes

Stay organized with collections Save and categorize content based on your preferences.

Resource: Lake

A lake is a centralized repository for managing enterprise data across the organization distributed across many cloud projects, and stored in a variety of storage services such as Google Cloud Storage and BigQuery. The resources attached to a lake are referred to as managed resources. Data within these managed resources can be structured or unstructured. A lake provides data admins with tools to organize, secure and manage their data at scale, and provides data scientists and data engineers an integrated experience to easily search, discover, analyze and transform data and associated metadata.

JSON representation
{
  "name": string,
  "displayName": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "state": enum (State),
  "serviceAccount": string,
  "metastore": {
    object (Metastore)
  },
  "assetStatus": {
    object (AssetStatus)
  },
  "metastoreStatus": {
    object (MetastoreStatus)
  }
}
Fields
name

string

Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{locationId}/lakes/{lakeId}.

displayName

string

Optional. User friendly display name.

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.

createTime

string (Timestamp format)

Output only. The time when the lake was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The time when the lake was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Optional. User-defined labels for the lake.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

Optional. Description of the lake.

state

enum (State)

Output only. Current state of the lake.

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.

metastore

object (Metastore)

Optional. Settings to manage lake and Dataproc Metastore service instance association.

assetStatus

object (AssetStatus)

Output only. Aggregated status of the underlying assets of the lake.

metastoreStatus

object (MetastoreStatus)

Output only. Metastore status of the lake.

Metastore

Settings to manage association of Dataproc Metastore with a lake.

JSON representation
{
  "service": string
}
Fields
service

string

Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{locationId}/services/{service_id}

MetastoreStatus

Status of Lake and Dataproc Metastore service instance association.

JSON representation
{
  "state": enum (State),
  "message": string,
  "updateTime": string,
  "endpoint": string
}
Fields
state

enum (State)

Current state of association.

message

string

Additional information about the current status.

updateTime

string (Timestamp format)

Last update time of the metastore status of the lake.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endpoint

string

The URI of the endpoint used to access the Metastore service.

State

Current state of association.

Enums
STATE_UNSPECIFIED Unspecified.
NONE A Metastore service instance is not associated with the lake.
READY A Metastore service instance is attached to the lake.
UPDATING Attach/detach is in progress.
ERROR Attach/detach could not be done due to errors.

Methods

create

Creates a lake resource.

delete

Deletes a lake resource.

get

Retrieves a lake resource.

getIamPolicy

Gets the access control policy for a resource.

list

Lists lake resources in a project and location.

patch

Updates a lake resource.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.