glossary_entries

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

Overview

Name	glossary_entries
Type	Resource
Id	google.translate.glossary_entries

Fields

The following fields are returned by SELECT queries:

projects_locations_glossaries_glossary_entries_get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the entry. Format: projects/*/locations/*/glossaries/*/glossaryEntries/*
description	string	Describes the glossary entry.
termsPair	object	Used for an unidirectional glossary. (id: GlossaryTermsPair)
termsSet	object	Used for an equivalent term sets glossary. (id: GlossaryTermsSet)

projects_locations_glossaries_glossary_entries_list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the entry. Format: projects/*/locations/*/glossaries/*/glossaryEntries/*
description	string	Describes the glossary entry.
termsPair	object	Used for an unidirectional glossary. (id: GlossaryTermsPair)
termsSet	object	Used for an equivalent term sets glossary. (id: GlossaryTermsSet)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_glossaries_glossary_entries_get	select	projectsId, locationsId, glossariesId, glossaryEntriesId		Gets a single glossary entry by the given id.
projects_locations_glossaries_glossary_entries_list	select	projectsId, locationsId, glossariesId	pageSize, pageToken	List the entries for the glossary.
projects_locations_glossaries_glossary_entries_create	insert	projectsId, locationsId, glossariesId		Creates a glossary entry.
projects_locations_glossaries_glossary_entries_patch	update	projectsId, locationsId, glossariesId, glossaryEntriesId		Updates a glossary entry.
projects_locations_glossaries_glossary_entries_delete	delete	projectsId, locationsId, glossariesId, glossaryEntriesId		Deletes a single entry from the glossary

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
glossaryEntriesId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_glossaries_glossary_entries_get

Gets a single glossary entry by the given id.

SELECT
name,
description,
termsPair,
termsSet
FROM google.translate.glossary_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND glossariesId = '{{ glossariesId }}' -- required
AND glossaryEntriesId = '{{ glossaryEntriesId }}' -- required;

projects_locations_glossaries_glossary_entries_list

List the entries for the glossary.

SELECT
name,
description,
termsPair,
termsSet
FROM google.translate.glossary_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND glossariesId = '{{ glossariesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_glossaries_glossary_entries_create

Creates a glossary entry.

INSERT INTO google.translate.glossary_entries (
data__name,
data__termsPair,
data__termsSet,
data__description,
projectsId,
locationsId,
glossariesId
)
SELECT 
'{{ name }}',
'{{ termsPair }}',
'{{ termsSet }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ glossariesId }}'
RETURNING
name,
description,
termsPair,
termsSet
;

Manifest

# Description fields are for documentation purposes
- name: glossary_entries
  props:
    - name: projectsId
      value: string
      description: Required parameter for the glossary_entries resource.
    - name: locationsId
      value: string
      description: Required parameter for the glossary_entries resource.
    - name: glossariesId
      value: string
      description: Required parameter for the glossary_entries resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
        
    - name: termsPair
      value: object
      description: >
        Used for an unidirectional glossary.
        
    - name: termsSet
      value: object
      description: >
        Used for an equivalent term sets glossary.
        
    - name: description
      value: string
      description: >
        Describes the glossary entry.
        

UPDATE examples

projects_locations_glossaries_glossary_entries_patch

Updates a glossary entry.

UPDATE google.translate.glossary_entries
SET 
data__name = '{{ name }}',
data__termsPair = '{{ termsPair }}',
data__termsSet = '{{ termsSet }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND glossariesId = '{{ glossariesId }}' --required
AND glossaryEntriesId = '{{ glossaryEntriesId }}' --required
RETURNING
name,
description,
termsPair,
termsSet;

DELETE examples

projects_locations_glossaries_glossary_entries_delete

Deletes a single entry from the glossary

DELETE FROM google.translate.glossary_entries
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND glossariesId = '{{ glossariesId }}' --required
AND glossaryEntriesId = '{{ glossaryEntriesId }}' --required;