data_attribute_bindings

Creates, updates, deletes, gets or lists a data_attribute_bindings resource.

Overview

Name	data_attribute_bindings
Type	Resource
Id	google.dataplex.data_attribute_bindings

Fields

The following fields are returned by SELECT queries:

projects_locations_data_attribute_bindings_get

Successful response

Name	Datatype	Description
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}
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}
createTime	string (google-datetime)	Output only. The time when the DataAttributeBinding was created.
description	string	Optional. Description of the DataAttributeBinding.
displayName	string	Optional. User friendly display name.
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.
labels	object	Optional. User-defined labels for the DataAttributeBinding.
paths	array	Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
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.
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.
updateTime	string (google-datetime)	Output only. The time when the DataAttributeBinding was last updated.

projects_locations_data_attribute_bindings_list

Successful response

Name	Datatype	Description
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}
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}
createTime	string (google-datetime)	Output only. The time when the DataAttributeBinding was created.
description	string	Optional. Description of the DataAttributeBinding.
displayName	string	Optional. User friendly display name.
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.
labels	object	Optional. User-defined labels for the DataAttributeBinding.
paths	array	Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
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.
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.
updateTime	string (google-datetime)	Output only. The time when the DataAttributeBinding was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_attribute_bindings_get	select	projectsId, locationsId, dataAttributeBindingsId		Retrieves a DataAttributeBinding resource.
projects_locations_data_attribute_bindings_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists DataAttributeBinding resources in a project and location.
projects_locations_data_attribute_bindings_create	insert	projectsId, locationsId	dataAttributeBindingId, validateOnly	Create a DataAttributeBinding resource.
projects_locations_data_attribute_bindings_patch	update	projectsId, locationsId, dataAttributeBindingsId	updateMask, validateOnly	Updates a DataAttributeBinding resource.
projects_locations_data_attribute_bindings_delete	delete	projectsId, locationsId, dataAttributeBindingsId	etag	Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataAttributeBindingsId	string
locationsId	string
projectsId	string
dataAttributeBindingId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_data_attribute_bindings_get

Retrieves a DataAttributeBinding resource.

SELECT
name,
attributes,
createTime,
description,
displayName,
etag,
labels,
paths,
resource,
uid,
updateTime
FROM google.dataplex.data_attribute_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataAttributeBindingsId = '{{ dataAttributeBindingsId }}' -- required;

projects_locations_data_attribute_bindings_list

Lists DataAttributeBinding resources in a project and location.

SELECT
name,
attributes,
createTime,
description,
displayName,
etag,
labels,
paths,
resource,
uid,
updateTime
FROM google.dataplex.data_attribute_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_data_attribute_bindings_create

Create a DataAttributeBinding resource.

INSERT INTO google.dataplex.data_attribute_bindings (
data__description,
data__displayName,
data__labels,
data__etag,
data__resource,
data__attributes,
data__paths,
projectsId,
locationsId,
dataAttributeBindingId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ etag }}',
'{{ resource }}',
'{{ attributes }}',
'{{ paths }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataAttributeBindingId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: data_attribute_bindings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the data_attribute_bindings resource.
    - name: locationsId
      value: string
      description: Required parameter for the data_attribute_bindings resource.
    - name: description
      value: string
      description: >
        Optional. Description of the DataAttributeBinding.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the DataAttributeBinding.
        
    - name: etag
      value: string
      description: >
        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.
        
    - name: resource
      value: string
      description: >
        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.
        
    - name: attributes
      value: array
      description: >
        Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
        
    - name: paths
      value: array
      description: >
        Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
        
    - name: dataAttributeBindingId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_data_attribute_bindings_patch

Updates a DataAttributeBinding resource.

UPDATE google.dataplex.data_attribute_bindings
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__resource = '{{ resource }}',
data__attributes = '{{ attributes }}',
data__paths = '{{ paths }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataAttributeBindingsId = '{{ dataAttributeBindingsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_data_attribute_bindings_delete

Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

DELETE FROM google.dataplex.data_attribute_bindings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataAttributeBindingsId = '{{ dataAttributeBindingsId }}' --required
AND etag = '{{ etag }}';