REST Resource: projects.locations.glossaries.glossaryEntries

Stay organized with collections Save and categorize content based on your preferences.

Resource: GlossaryEntry

Represents a single entry in a glossary.

JSON representation
{
  "name": string,
  "description": string,

  // Union field data can be only one of the following:
  "termsPair": {
    object (GlossaryTermsPair)
  },
  "termsSet": {
    object (GlossaryTermsSet)
  }
  // End of list of possible types for union field data.
}
Fields
name

string

Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"

description

string

Describes the glossary entry.

Union field data. The different data for the glossary types (Unidirectional, Equivalent term sets). data can be only one of the following:
termsPair

object (GlossaryTermsPair)

Used for an unidirectional glossary.

termsSet

object (GlossaryTermsSet)

Used for an equivalent term sets glossary.

GlossaryTermsPair

Represents a single entry for an unidirectional glossary.

JSON representation
{
  "sourceTerm": {
    object (GlossaryTerm)
  },
  "targetTerm": {
    object (GlossaryTerm)
  }
}
Fields
sourceTerm

object (GlossaryTerm)

The source term is the term that will get match in the text,

targetTerm

object (GlossaryTerm)

The term that will replace the match source term.

GlossaryTerm

Represents a single glossary term

JSON representation
{
  "languageCode": string,
  "text": string
}
Fields
languageCode

string

The language for this glossary term.

text

string

The text for the glossary term.

GlossaryTermsSet

Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set.

JSON representation
{
  "terms": [
    {
      object (GlossaryTerm)
    }
  ]
}
Fields
terms[]

object (GlossaryTerm)

Each term in the set represents a term that can be replaced by the other terms.

Methods

create

Creates a glossary entry.

delete

Deletes a single entry from the glossary

get

Gets a single glossary entry by the given id.

list

List the entries for the glossary.

patch

Updates a glossary entry.