categories

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

Overview

Name	categories
Type	Resource
Id	google.dataplex.categories

Fields

The following fields are returned by SELECT queries:

projects_locations_glossaries_categories_get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
createTime	string (google-datetime)	Output only. The time at which the GlossaryCategory was created.
description	string	Optional. The user-mutable description of the GlossaryCategory.
displayName	string	Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
labels	object	Optional. User-defined labels for the GlossaryCategory.
parent	string	Required. The immediate parent of the GlossaryCategory 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 GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time at which the GlossaryCategory was last updated.

projects_locations_glossaries_categories_list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
createTime	string (google-datetime)	Output only. The time at which the GlossaryCategory was created.
description	string	Optional. The user-mutable description of the GlossaryCategory.
displayName	string	Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
labels	object	Optional. User-defined labels for the GlossaryCategory.
parent	string	Required. The immediate parent of the GlossaryCategory 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 GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
updateTime	string (google-datetime)	Output only. The time at which the GlossaryCategory was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_glossaries_categories_get	select	projectsId, locationsId, glossariesId, categoriesId		Gets a GlossaryCategory resource.
projects_locations_glossaries_categories_list	select	projectsId, locationsId, glossariesId	pageSize, pageToken, filter, orderBy	Lists GlossaryCategory resources in a Glossary.
projects_locations_glossaries_categories_create	insert	projectsId, locationsId, glossariesId	categoryId	Creates a new GlossaryCategory resource.
projects_locations_glossaries_categories_patch	update	projectsId, locationsId, glossariesId, categoriesId	updateMask	Updates a GlossaryCategory resource.
projects_locations_glossaries_categories_delete	delete	projectsId, locationsId, glossariesId, categoriesId		Deletes a GlossaryCategory resource. All the GlossaryCategories and GlossaryTerms nested directly under the specified GlossaryCategory will be moved one level up to the parent in the hierarchy.

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
categoriesId	string
glossariesId	string
locationsId	string
projectsId	string
categoryId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_glossaries_categories_get

Gets a GlossaryCategory resource.

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

projects_locations_glossaries_categories_list

Lists GlossaryCategory resources in a Glossary.

SELECT
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime
FROM google.dataplex.categories
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_categories_create

Creates a new GlossaryCategory resource.

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

Manifest

# Description fields are for documentation purposes
- name: categories
  props:
    - name: projectsId
      value: string
      description: Required parameter for the categories resource.
    - name: locationsId
      value: string
      description: Required parameter for the categories resource.
    - name: glossariesId
      value: string
      description: Required parameter for the categories resource.
    - name: displayName
      value: string
      description: >
        Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
        
    - name: description
      value: string
      description: >
        Optional. The user-mutable description of the GlossaryCategory.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the GlossaryCategory.
        
    - name: parent
      value: string
      description: >
        Required. The immediate parent of the GlossaryCategory 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: categoryId
      value: string

UPDATE examples

projects_locations_glossaries_categories_patch

Updates a GlossaryCategory resource.

UPDATE google.dataplex.categories
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 categoriesId = '{{ categoriesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
labels,
parent,
uid,
updateTime;

DELETE examples

projects_locations_glossaries_categories_delete

Deletes a GlossaryCategory resource. All the GlossaryCategories and GlossaryTerms nested directly under the specified GlossaryCategory will be moved one level up to the parent in the hierarchy.

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