attributes

Creates, updates, deletes, gets or lists an attributes resource.

Overview

Name	attributes
Type	Resource
Id	google.dataplex.attributes

Fields

The following fields are returned by SELECT queries:

projects_locations_data_taxonomies_attributes_get

Successful response

Name	Datatype	Description
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}.
attributeCount	integer (int32)	Output only. The number of child attributes present for this attribute.
createTime	string (google-datetime)	Output only. The time when the DataAttribute was created.
dataAccessSpec	object	Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables). (id: GoogleCloudDataplexV1DataAccessSpec)
description	string	Optional. Description of the DataAttribute.
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.
labels	object	Optional. User-defined labels for the DataAttribute.
parentId	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
resourceAccessSpec	object	Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table). (id: GoogleCloudDataplexV1ResourceAccessSpec)
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.
updateTime	string (google-datetime)	Output only. The time when the DataAttribute was last updated.

projects_locations_data_taxonomies_attributes_list

Successful response

Name	Datatype	Description
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}.
attributeCount	integer (int32)	Output only. The number of child attributes present for this attribute.
createTime	string (google-datetime)	Output only. The time when the DataAttribute was created.
dataAccessSpec	object	Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables). (id: GoogleCloudDataplexV1DataAccessSpec)
description	string	Optional. Description of the DataAttribute.
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.
labels	object	Optional. User-defined labels for the DataAttribute.
parentId	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
resourceAccessSpec	object	Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table). (id: GoogleCloudDataplexV1ResourceAccessSpec)
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.
updateTime	string (google-datetime)	Output only. The time when the DataAttribute was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_taxonomies_attributes_get	select	projectsId, locationsId, dataTaxonomiesId, attributesId		Retrieves a Data Attribute resource.
projects_locations_data_taxonomies_attributes_list	select	projectsId, locationsId, dataTaxonomiesId	pageSize, pageToken, filter, orderBy	Lists Data Attribute resources in a DataTaxonomy.
projects_locations_data_taxonomies_attributes_create	insert	projectsId, locationsId, dataTaxonomiesId	dataAttributeId, validateOnly	Create a DataAttribute resource.
projects_locations_data_taxonomies_attributes_patch	update	projectsId, locationsId, dataTaxonomiesId, attributesId	updateMask, validateOnly	Updates a DataAttribute resource.
projects_locations_data_taxonomies_attributes_delete	delete	projectsId, locationsId, dataTaxonomiesId, attributesId	etag	Deletes a Data Attribute resource.

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
attributesId	string
dataTaxonomiesId	string
locationsId	string
projectsId	string
dataAttributeId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_data_taxonomies_attributes_get

Retrieves a Data Attribute resource.

SELECT
name,
attributeCount,
createTime,
dataAccessSpec,
description,
displayName,
etag,
labels,
parentId,
resourceAccessSpec,
uid,
updateTime
FROM google.dataplex.attributes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' -- required
AND attributesId = '{{ attributesId }}' -- required;

projects_locations_data_taxonomies_attributes_list

Lists Data Attribute resources in a DataTaxonomy.

SELECT
name,
attributeCount,
createTime,
dataAccessSpec,
description,
displayName,
etag,
labels,
parentId,
resourceAccessSpec,
uid,
updateTime
FROM google.dataplex.attributes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_data_taxonomies_attributes_create

Create a DataAttribute resource.

INSERT INTO google.dataplex.attributes (
data__description,
data__displayName,
data__labels,
data__parentId,
data__etag,
data__resourceAccessSpec,
data__dataAccessSpec,
projectsId,
locationsId,
dataTaxonomiesId,
dataAttributeId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ parentId }}',
'{{ etag }}',
'{{ resourceAccessSpec }}',
'{{ dataAccessSpec }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataTaxonomiesId }}',
'{{ dataAttributeId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: attributes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the attributes resource.
    - name: locationsId
      value: string
      description: Required parameter for the attributes resource.
    - name: dataTaxonomiesId
      value: string
      description: Required parameter for the attributes resource.
    - name: description
      value: string
      description: >
        Optional. Description of the DataAttribute.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the DataAttribute.
        
    - name: parentId
      value: string
      description: >
        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
        
    - 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.
        
    - name: resourceAccessSpec
      value: object
      description: >
        Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
        
    - name: dataAccessSpec
      value: object
      description: >
        Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
        
    - name: dataAttributeId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_data_taxonomies_attributes_patch

Updates a DataAttribute resource.

UPDATE google.dataplex.attributes
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__parentId = '{{ parentId }}',
data__etag = '{{ etag }}',
data__resourceAccessSpec = '{{ resourceAccessSpec }}',
data__dataAccessSpec = '{{ dataAccessSpec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' --required
AND attributesId = '{{ attributesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_data_taxonomies_attributes_delete

Deletes a Data Attribute resource.

DELETE FROM google.dataplex.attributes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' --required
AND attributesId = '{{ attributesId }}' --required
AND etag = '{{ etag }}';