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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time when the DataAttributeBinding was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the DataAttributeBinding was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the DataAttributeBinding was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the DataAttributeBinding was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the DataAttributeBinding.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the DataAttributeBinding.
| 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 DataAttributeBinding.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. User-defined labels for the DataAttributeBinding.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| 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.
Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
| 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.
Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataAttributeBinding\Path>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceReference
| Returns | |
|---|---|
| Type | Description |
string | |