data_taxonomies

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

Overview

Name	data_taxonomies
Type	Resource
Id	google.dataplex.data_taxonomies

Fields

The following fields are returned by SELECT queries:

projects_locations_data_taxonomies_get

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
attributeCount	integer (int32)	Output only. The number of attributes in the DataTaxonomy.
classCount	integer (int32)	Output only. The number of classes in the DataTaxonomy.
createTime	string (google-datetime)	Output only. The time when the DataTaxonomy was created.
description	string	Optional. Description of the DataTaxonomy.
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 DataTaxonomy.
uid	string	Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time when the DataTaxonomy was last updated.

projects_locations_data_taxonomies_list

Successful response

Name	Datatype	Description
name	string	Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
attributeCount	integer (int32)	Output only. The number of attributes in the DataTaxonomy.
classCount	integer (int32)	Output only. The number of classes in the DataTaxonomy.
createTime	string (google-datetime)	Output only. The time when the DataTaxonomy was created.
description	string	Optional. Description of the DataTaxonomy.
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 DataTaxonomy.
uid	string	Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time when the DataTaxonomy was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_taxonomies_get	select	projectsId, locationsId, dataTaxonomiesId		Retrieves a DataTaxonomy resource.
projects_locations_data_taxonomies_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists DataTaxonomy resources in a project and location.
projects_locations_data_taxonomies_create	insert	projectsId, locationsId	dataTaxonomyId, validateOnly	Create a DataTaxonomy resource.
projects_locations_data_taxonomies_patch	update	projectsId, locationsId, dataTaxonomiesId	updateMask, validateOnly	Updates a DataTaxonomy resource.
projects_locations_data_taxonomies_delete	delete	projectsId, locationsId, dataTaxonomiesId	etag	Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy 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
dataTaxonomiesId	string
locationsId	string
projectsId	string
dataTaxonomyId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_data_taxonomies_get

Retrieves a DataTaxonomy resource.

SELECT
name,
attributeCount,
classCount,
createTime,
description,
displayName,
etag,
labels,
uid,
updateTime
FROM google.dataplex.data_taxonomies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' -- required;

projects_locations_data_taxonomies_list

Lists DataTaxonomy resources in a project and location.

SELECT
name,
attributeCount,
classCount,
createTime,
description,
displayName,
etag,
labels,
uid,
updateTime
FROM google.dataplex.data_taxonomies
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_taxonomies_create

Create a DataTaxonomy resource.

INSERT INTO google.dataplex.data_taxonomies (
data__description,
data__displayName,
data__labels,
data__etag,
projectsId,
locationsId,
dataTaxonomyId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataTaxonomyId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: data_taxonomies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the data_taxonomies resource.
    - name: locationsId
      value: string
      description: Required parameter for the data_taxonomies resource.
    - name: description
      value: string
      description: >
        Optional. Description of the DataTaxonomy.
        
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the DataTaxonomy.
        
    - 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: dataTaxonomyId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_data_taxonomies_patch

Updates a DataTaxonomy resource.

UPDATE google.dataplex.data_taxonomies
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataTaxonomiesId = '{{ dataTaxonomiesId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_data_taxonomies_delete

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

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