glossaries

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

Overview

Name	`glossaries`
Type	Resource
Id	`google.dataplex.glossaries`

Fields

The following fields are returned by SELECT queries:

projects_locations_glossaries_get
projects_locations_glossaries_list

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
`categoryCount`	`integer (int32)`	Output only. The number of GlossaryCategories in the Glossary.
`createTime`	`string (google-datetime)`	Output only. The time at which the Glossary was created.
`description`	`string`	Optional. The user-mutable description of the Glossary.
`displayName`	`string`	Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
`etag`	`string`	Optional. Needed for resource freshness validation. 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 Glossary.
`termCount`	`integer (int32)`	Output only. The number of GlossaryTerms in the Glossary.
`uid`	`string`	Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
`updateTime`	`string (google-datetime)`	Output only. The time at which the Glossary was last updated.

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
`categoryCount`	`integer (int32)`	Output only. The number of GlossaryCategories in the Glossary.
`createTime`	`string (google-datetime)`	Output only. The time at which the Glossary was created.
`description`	`string`	Optional. The user-mutable description of the Glossary.
`displayName`	`string`	Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
`etag`	`string`	Optional. Needed for resource freshness validation. 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 Glossary.
`termCount`	`integer (int32)`	Output only. The number of GlossaryTerms in the Glossary.
`uid`	`string`	Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
`updateTime`	`string (google-datetime)`	Output only. The time at which the Glossary was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`projects_locations_glossaries_get`	`select`	`projectsId`, `locationsId`, `glossariesId`		Gets a Glossary resource.
`projects_locations_glossaries_list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists Glossary resources in a project and location.
`projects_locations_glossaries_create`	`insert`	`projectsId`, `locationsId`	`glossaryId`, `validateOnly`	Creates a new Glossary resource.
`projects_locations_glossaries_patch`	`update`	`projectsId`, `locationsId`, `glossariesId`	`updateMask`, `validateOnly`	Updates a Glossary resource.
`projects_locations_glossaries_delete`	`delete`	`projectsId`, `locationsId`, `glossariesId`	`etag`	Deletes a Glossary resource. All the categories and terms within the Glossary must be deleted before the Glossary 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
`glossariesId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`etag`	`string`
`filter`	`string`
`glossaryId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

projects_locations_glossaries_get
projects_locations_glossaries_list

Gets a Glossary resource.

SELECT
name,
categoryCount,
createTime,
description,
displayName,
etag,
labels,
termCount,
uid,
updateTime
FROM google.dataplex.glossaries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND glossariesId = '{{ glossariesId }}' -- required;

Lists Glossary resources in a project and location.

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

`INSERT` examples

projects_locations_glossaries_create
Manifest

Creates a new Glossary resource.

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

# Description fields are for documentation purposes
- name: glossaries
  props:
    - name: projectsId
      value: string
      description: Required parameter for the glossaries resource.
    - name: locationsId
      value: string
      description: Required parameter for the glossaries resource.
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
        
    - name: description
      value: string
      description: >
        Optional. The user-mutable description of the Glossary.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the Glossary.
        
    - name: etag
      value: string
      description: >
        Optional. Needed for resource freshness validation. 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: glossaryId
      value: string
    - name: validateOnly
      value: boolean

`UPDATE` examples

projects_locations_glossaries_patch

Updates a Glossary resource.

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

`DELETE` examples

projects_locations_glossaries_delete

Deletes a Glossary resource. All the categories and terms within the Glossary must be deleted before the Glossary can be deleted.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​