Google Cloud Dataplex V1 Client - Class CreateLakeRequest (0.6.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class CreateLakeRequest.

Create lake request.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
`↳ lake_id`	`string` Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
`↳ lake`	`Google\Cloud\Dataplex\V1\Lake` Required. Lake resource
`↳ validate_only`	`bool` Optional. Only validate the request, but do not perform mutations. The default is false.

getParent

Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.

Returns
Type	Description
`string`

setParent

Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLakeId

Required. Lake identifier.

This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery.

Must contain only lowercase letters, numbers and hyphens.
Must start with a letter.
Must end with a number or a letter.
Must be between 1-63 characters.
Must be unique within the customer project / location.

Returns
Type	Description
`string`

setLakeId

Required. Lake identifier.

This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery.

Must contain only lowercase letters, numbers and hyphens.
Must start with a letter.
Must end with a number or a letter.
Must be between 1-63 characters.
Must be unique within the customer project / location.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLake

Required. Lake resource

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

hasLake

clearLake

setLake

Required. Lake resource

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

Returns
Type	Description
`$this`

getValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Returns
Type	Description
`bool`

setValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region. Please see Google\Cloud\Dataplex\V1\DataplexServiceClient::locationName() for help formatting this field.
`lake`	`Google\Cloud\Dataplex\V1\Lake` Required. Lake resource
`lakeId`	`string` Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.

Returns
Type	Description
`Google\Cloud\Dataplex\V1\CreateLakeRequest`