terms

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

Overview

Name	terms
Type	Resource
Id	google.dataplex.terms

Fields

The following fields are returned by SELECT queries:

projects_locations_glossaries_terms_get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
createTime	string (google-datetime)	Output only. The time at which the GlossaryTerm was created.
description	string	Optional. The user-mutable description of the GlossaryTerm.
displayName	string	Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
labels	object	Optional. User-defined labels for the GlossaryTerm.
parent	string	Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
uid	string	Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time at which the GlossaryTerm was last updated.

projects_locations_glossaries_terms_list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
createTime	string (google-datetime)	Output only. The time at which the GlossaryTerm was created.
description	string	Optional. The user-mutable description of the GlossaryTerm.
displayName	string	Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
labels	object	Optional. User-defined labels for the GlossaryTerm.
parent	string	Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
uid	string	Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time at which the GlossaryTerm was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_glossaries_terms_get	select	projectsId, locationsId, glossariesId, termsId		Gets a GlossaryTerm resource.
projects_locations_glossaries_terms_list	select	projectsId, locationsId, glossariesId	pageSize, pageToken, filter, orderBy	Lists GlossaryTerm resources in a Glossary.
projects_locations_glossaries_terms_create	insert	projectsId, locationsId, glossariesId	termId	Creates a new GlossaryTerm resource.
projects_locations_glossaries_terms_patch	update	projectsId, locationsId, glossariesId, termsId	updateMask	Updates a GlossaryTerm resource.
projects_locations_glossaries_terms_delete	delete	projectsId, locationsId, glossariesId, termsId		Deletes a GlossaryTerm 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
glossariesId	string
locationsId	string
projectsId	string
termsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
termId	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_glossaries_terms_get

Gets a GlossaryTerm resource.

SELECT
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime
FROM google.dataplex.terms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND glossariesId = '{{ glossariesId }}' -- required
AND termsId = '{{ termsId }}' -- required;

projects_locations_glossaries_terms_list

Lists GlossaryTerm resources in a Glossary.

SELECT
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime
FROM google.dataplex.terms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND glossariesId = '{{ glossariesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_glossaries_terms_create

Creates a new GlossaryTerm resource.

INSERT INTO google.dataplex.terms (
data__displayName,
data__description,
data__labels,
data__parent,
projectsId,
locationsId,
glossariesId,
termId
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ labels }}',
'{{ parent }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ glossariesId }}',
'{{ termId }}'
RETURNING
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: terms
  props:
    - name: projectsId
      value: string
      description: Required parameter for the terms resource.
    - name: locationsId
      value: string
      description: Required parameter for the terms resource.
    - name: glossariesId
      value: string
      description: Required parameter for the terms resource.
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
        
    - name: description
      value: string
      description: >
        Optional. The user-mutable description of the GlossaryTerm.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the GlossaryTerm.
        
    - name: parent
      value: string
      description: >
        Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
        
    - name: termId
      value: string

UPDATE examples

projects_locations_glossaries_terms_patch

Updates a GlossaryTerm resource.

UPDATE google.dataplex.terms
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__parent = '{{ parent }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND glossariesId = '{{ glossariesId }}' --required
AND termsId = '{{ termsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime;

DELETE examples

projects_locations_glossaries_terms_delete

Deletes a GlossaryTerm resource.

DELETE FROM google.dataplex.terms
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND glossariesId = '{{ glossariesId }}' --required
AND termsId = '{{ termsId }}' --required;