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
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 |
↳ 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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field string lake_id = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string lake_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLake
Required. Lake resource
Generated from protobuf field .google.cloud.dataplex.v1.Lake lake = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Lake|null | |
hasLake
clearLake
setLake
Required. Lake resource
Generated from protobuf field .google.cloud.dataplex.v1.Lake lake = 3 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
Optional. Only validate the request, but do not perform mutations.
The default is false.
Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |