Google Cloud Dataplex V1 Client - Class DataTaxonomy (0.12.0)

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

DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

↳ uid string

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the DataTaxonomy was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The time when the DataTaxonomy was last updated.

↳ description string

Optional. Description of the DataTaxonomy.

↳ display_name string

Optional. User friendly display name.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels for the DataTaxonomy.

↳ attribute_count int

Output only. The number of attributes in the DataTaxonomy.

↳ etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

↳ class_count int

Output only. The number of classes in the DataTaxonomy.

getName

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

Returns
TypeDescription
string

setName

Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

Returns
TypeDescription
string

setUid

Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the DataTaxonomy was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the DataTaxonomy was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The time when the DataTaxonomy was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the DataTaxonomy was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDescription

Optional. Description of the DataTaxonomy.

Returns
TypeDescription
string

setDescription

Optional. Description of the DataTaxonomy.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Optional. User friendly display name.

Returns
TypeDescription
string

setDisplayName

Optional. User friendly display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabels

Optional. User-defined labels for the DataTaxonomy.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels for the DataTaxonomy.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getAttributeCount

Output only. The number of attributes in the DataTaxonomy.

Returns
TypeDescription
int

setAttributeCount

Output only. The number of attributes in the DataTaxonomy.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClassCount

Output only. The number of classes in the DataTaxonomy.

Returns
TypeDescription
int

setClassCount

Output only. The number of classes in the DataTaxonomy.

Parameter
NameDescription
var int
Returns
TypeDescription
$this