attributes

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

Overview

Name	attributes
Type	Resource
Id	google.dataplex.attributes

Fields

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}.
description	string	Optional. Description of the DataAttribute.
attributeCount	integer	Output only. The number of child attributes present for this attribute.
createTime	string	Output only. The time when the DataAttribute was created.
dataAccessSpec	object	DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.
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	ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.
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	Output only. The time when the DataAttribute was last updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_data_taxonomies_attributes_get	SELECT	attributesId, dataTaxonomiesId, locationsId, projectsId	Retrieves a Data Attribute resource.
projects_locations_data_taxonomies_attributes_list	SELECT	dataTaxonomiesId, locationsId, projectsId	Lists Data Attribute resources in a DataTaxonomy.
projects_locations_data_taxonomies_attributes_create	INSERT	dataTaxonomiesId, locationsId, projectsId	Create a DataAttribute resource.
projects_locations_data_taxonomies_attributes_delete	DELETE	attributesId, dataTaxonomiesId, locationsId, projectsId	Deletes a Data Attribute resource.
projects_locations_data_taxonomies_attributes_patch	UPDATE	attributesId, dataTaxonomiesId, locationsId, projectsId	Updates a DataAttribute resource.

SELECT examples

Lists Data Attribute resources in a DataTaxonomy.

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

INSERT example

Use the following StackQL query and manifest file to create a new attributes resource.

All Properties

/*+ create */
INSERT INTO google.dataplex.attributes (
dataTaxonomiesId,
locationsId,
projectsId,
description,
displayName,
labels,
parentId,
etag,
resourceAccessSpec,
dataAccessSpec
)
SELECT 
'{{ dataTaxonomiesId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ parentId }}',
'{{ etag }}',
'{{ resourceAccessSpec }}',
'{{ dataAccessSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: description
      value: string
    - name: displayName
      value: string
    - name: labels
      value: object
    - name: parentId
      value: string
    - name: attributeCount
      value: integer
    - name: etag
      value: string
    - name: resourceAccessSpec
      value:
        - name: readers
          value:
            - string
        - name: writers
          value:
            - string
        - name: owners
          value:
            - string
    - name: dataAccessSpec
      value:
        - name: readers
          value:
            - string

UPDATE example

Updates a attributes resource.

/*+ update */
UPDATE google.dataplex.attributes
SET 
description = '{{ description }}',
displayName = '{{ displayName }}',
labels = '{{ labels }}',
parentId = '{{ parentId }}',
etag = '{{ etag }}',
resourceAccessSpec = '{{ resourceAccessSpec }}',
dataAccessSpec = '{{ dataAccessSpec }}'
WHERE 
attributesId = '{{ attributesId }}'
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified attributes resource.

/*+ delete */
DELETE FROM google.dataplex.attributes
WHERE attributesId = '{{ attributesId }}'
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';