Google Cloud Dataplex V1 Client - Class DataAttributeBinding (0.10.0)

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

DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.

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

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 Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}

↳ uid string

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

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the DataAttributeBinding was created.

↳ update_time Google\Protobuf\Timestamp

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

↳ description string

Optional. Description of the DataAttributeBinding.

↳ display_name string

Optional. User friendly display name.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels for the DataAttributeBinding.

↳ 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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.

↳ resource string

Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.

↳ attributes array

Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

↳ paths array<Google\Cloud\Dataplex\V1\DataAttributeBinding\Path>

Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.

getName

Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}

Returns
TypeDescription
string

setName

Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

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

Returns
TypeDescription
string

setUid

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the DataAttributeBinding was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the DataAttributeBinding was created.

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

getUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

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

getDescription

Optional. Description of the DataAttributeBinding.

Returns
TypeDescription
string

setDescription

Optional. Description of the DataAttributeBinding.

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 DataAttributeBinding.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels for the DataAttributeBinding.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
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.

Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.

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.

Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResource

Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.

Returns
TypeDescription
string

hasResource

setResource

Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAttributes

Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAttributes

Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getPaths

Optional. The list of paths for items within the associated resource (eg.

columns and partitions within a table) along with attribute bindings.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPaths

Optional. The list of paths for items within the associated resource (eg.

columns and partitions within a table) along with attribute bindings.

Parameter
NameDescription
var array<Google\Cloud\Dataplex\V1\DataAttributeBinding\Path>
Returns
TypeDescription
$this

getResourceReference

Returns
TypeDescription
string