Google Cloud Dataplex V1 Client - Class DataAttribute (1.0.0)

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

Denotes one dataAttribute in a dataTaxonomy, for example, PII.

DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types

PII
  - ResourceAccessSpec :
                - readers :foo@bar.com
  - DataAccessSpec :
                - readers :bar@foo.com

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
↳ uid string

Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
↳ create_time Google\Protobuf\Timestamp

Output only. The time when the DataAttribute was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time when the DataAttribute was last updated.
↳ description string

Optional. Description of the DataAttribute.
↳ display_name string

Optional. User friendly display name.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels for the DataAttribute.
↳ parent_id string

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]
↳ attribute_count int

Output only. The number of child attributes present for this attribute.
↳ 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.
↳ resource_access_spec Google\Cloud\Dataplex\V1\ResourceAccessSpec

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
↳ data_access_spec Google\Cloud\Dataplex\V1\DataAccessSpec

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

getName

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

Returns
Type Description
string

setName

Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. System generated globally unique ID for the DataAttribute.

This ID will be different if the DataAttribute is deleted and re-created with the same name.

Returns
Type Description
string

setUid

Output only. System generated globally unique ID for the DataAttribute.

This ID will be different if the DataAttribute is deleted and re-created with the same name.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time when the DataAttribute was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the DataAttribute was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDescription

Optional. Description of the DataAttribute.

Returns
Type Description
string

setDescription

Optional. Description of the DataAttribute.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. User friendly display name.

Returns
Type Description
string

setDisplayName

Optional. User friendly display name.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. User-defined labels for the DataAttribute.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels for the DataAttribute.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getParentId

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid.

Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]

Returns
Type Description
string

setParentId

Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid.

Maximum depth of the hierarchy allowed is 4. [a -> b -> c -> d -> e, depth = 4]

Parameter
Name Description
var string
Returns
Type Description
$this

getAttributeCount

Output only. The number of child attributes present for this attribute.

Returns
Type Description
int

setAttributeCount

Output only. The number of child attributes present for this attribute.

Parameter
Name Description
var int
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getResourceAccessSpec

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

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

hasResourceAccessSpec

clearResourceAccessSpec

setResourceAccessSpec

Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).

Parameter
Name Description
var Google\Cloud\Dataplex\V1\ResourceAccessSpec
Returns
Type Description
$this

getDataAccessSpec

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

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

hasDataAccessSpec

clearDataAccessSpec

setDataAccessSpec

Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).

Parameter
Name Description
var Google\Cloud\Dataplex\V1\DataAccessSpec
Returns
Type Description
$this