Google Cloud Dataplex V1 Client - Class CreateDataTaxonomyRequest (0.8.0)

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

Create DataTaxonomy request.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ data_taxonomy_id string

Required. DataTaxonomy identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Project.

↳ data_taxonomy Google\Cloud\Dataplex\V1\DataTaxonomy

Required. DataTaxonomy 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 data taxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataTaxonomyId

Required. DataTaxonomy identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the Project.
Returns
TypeDescription
string

setDataTaxonomyId

Required. DataTaxonomy identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the Project.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataTaxonomy

Required. DataTaxonomy resource.

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

hasDataTaxonomy

clearDataTaxonomy

setDataTaxonomy

Required. DataTaxonomy resource.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataTaxonomy
Returns
TypeDescription
$this

getValidateOnly

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

The default is false.

Returns
TypeDescription
bool

setValidateOnly

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

The default is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The resource name of the data taxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. Please see Google\Cloud\Dataplex\V1\DataTaxonomyServiceClient::locationName() for help formatting this field.

dataTaxonomy Google\Cloud\Dataplex\V1\DataTaxonomy

Required. DataTaxonomy resource.

dataTaxonomyId string

Required. DataTaxonomy identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the Project.
Returns
TypeDescription
Google\Cloud\Dataplex\V1\CreateDataTaxonomyRequest