Google Cloud Dataplex V1 Client - Class Lake (0.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class 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.

Generated from protobuf message google.cloud.dataplex.v1.Lake

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The relative resource name of the lake, of the form: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
`↳ display_name`	`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.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time when the lake was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time when the lake was last updated.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. User-defined labels for the lake.
`↳ description`	`string` Optional. Description of the lake.
`↳ state`	`int` Output only. Current state of the lake.
`↳ service_account`	`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`	`Google\Cloud\Dataplex\V1\Lake\Metastore` Optional. Settings to manage lake and Dataproc Metastore service instance association.
`↳ asset_status`	`Google\Cloud\Dataplex\V1\AssetStatus` Output only. Aggregated status of the underlying assets of the lake.
`↳ metastore_status`	`Google\Cloud\Dataplex\V1\Lake\MetastoreStatus` Output only. Metastore status of the lake.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. User friendly display name.

Returns
Type	Description
`string`

setDisplayName

Optional. User friendly display name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

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.

Returns
Type	Description
`string`

setUid

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the lake was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the lake was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Optional. User-defined labels for the lake.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. User-defined labels for the lake.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the lake.

Returns
Type	Description
`string`

setDescription

Optional. Description of the lake.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. Current state of the lake.

Returns
Type	Description
`int`

setState

Output only. Current state of the lake.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getServiceAccount

Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.

Returns
Type	Description
`string`

setServiceAccount

Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMetastore

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

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Lake\Metastore\|null`

hasMetastore

clearMetastore

setMetastore

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

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Lake\Metastore`

Returns
Type	Description
`$this`

getAssetStatus

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

Returns
Type	Description
`Google\Cloud\Dataplex\V1\AssetStatus\|null`

hasAssetStatus

clearAssetStatus

setAssetStatus

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

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\AssetStatus`

Returns
Type	Description
`$this`

getMetastoreStatus

Output only. Metastore status of the lake.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\Lake\MetastoreStatus\|null`

hasMetastoreStatus

clearMetastoreStatus

setMetastoreStatus

Output only. Metastore status of the lake.

Parameter
Name	Description
`var`	`Google\Cloud\Dataplex\V1\Lake\MetastoreStatus`

Returns
Type	Description
`$this`