Google Cloud Dataplex V1 Client - Class CreateZoneRequest (0.15.1)

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

Create zone request.

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

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 parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
↳ zone_id string

Required. Zone 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 across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp")
↳ zone Google\Cloud\Dataplex\V1\Zone

Required. Zone 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 parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.

Returns
Type Description
string

setParent

Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getZoneId

Required. Zone 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 across all lakes from all locations in a project.
  • Must not be one of the reserved IDs (i.e. "default", "global-temp")
Returns
Type Description
string

setZoneId

Required. Zone 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 across all lakes from all locations in a project.
  • Must not be one of the reserved IDs (i.e. "default", "global-temp")
Parameter
Name Description
var string
Returns
Type Description
$this

getZone

Required. Zone resource.

Returns
Type Description
Google\Cloud\Dataplex\V1\Zone|null

hasZone

clearZone

setZone

Required. Zone resource.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\Zone
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 parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. Please see Google\Cloud\Dataplex\V1\DataplexServiceClient::lakeName() for help formatting this field.
zone Google\Cloud\Dataplex\V1\Zone

Required. Zone resource.
zoneId string

Required. Zone 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 across all lakes from all locations in a project.
  • Must not be one of the reserved IDs (i.e. "default", "global-temp")
Returns
Type Description
Google\Cloud\Dataplex\V1\CreateZoneRequest