Google Cloud Dataplex V1 Client - Class CreateZoneRequest (0.1.6)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$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")

Generated from protobuf field string zone_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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")

Generated from protobuf field string zone_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

Required. Zone resource.

Generated from protobuf field .google.cloud.dataplex.v1.Zone zone = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Zone|null

hasZone

clearZone

setZone

Required. Zone resource.

Generated from protobuf field .google.cloud.dataplex.v1.Zone zone = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Zone
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this