REST Resource: projects.locations.glossaries

Resource: Glossary

A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it.

JSON representation
{
  "name": string,
  "uid": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "termCount": integer,
  "categoryCount": integer,
  "etag": string
}
Fields
name

string

Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}

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.

displayName

string

Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

description

string

Optional. The user-mutable description of the Glossary.

createTime

string (Timestamp format)

Output only. The time at which the Glossary was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time at which the Glossary was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. User-defined labels for the Glossary.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

termCount

integer

Output only. The number of GlossaryTerms in the Glossary.

categoryCount

integer

Output only. The number of GlossaryCategories in the Glossary.

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.

Methods

create

Creates a new Glossary resource.

delete

Deletes a Glossary resource.

get

Gets a Glossary resource.

list

Lists Glossary resources in a project and location.

patch

Updates a Glossary resource.