Google Cloud Dataplex V1 Client - Class Glossary (1.11.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class 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.

Generated from protobuf message google.cloud.dataplex.v1.Glossary

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ 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.

↳ display_name
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.

↳ create_time
Google\Protobuf\Timestamp

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

↳ update_time
Google\Protobuf\Timestamp

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

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. User-defined labels for the Glossary.

↳ term_count
int

Output only. The number of GlossaryTerms in the Glossary.

↳ category_count
int

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.

getName

Output only. Identifier. The resource name of the Glossary.

Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

Returns
Type
Description
string

setName

Output only. Identifier. The resource name of the Glossary.

Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

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.

Returns
Type
Description
string

setUid

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Optional. User friendly display name of the Glossary. This is user-mutable.

This will be same as the GlossaryId, if not specified.

Returns
Type
Description
string

setDisplayName

Optional. User friendly display name of the Glossary. This is user-mutable.

This will be same as the GlossaryId, if not specified.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. The user-mutable description of the Glossary.

Returns
Type
Description
string

setDescription

Optional. The user-mutable description of the Glossary.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

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

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

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

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. User-defined labels for the Glossary.

Returns
Type
Description

setLabels

Optional. User-defined labels for the Glossary.

Parameter
Name
Description
Returns
Type
Description
$this

getTermCount

Output only. The number of GlossaryTerms in the Glossary.

Returns
Type
Description
int

setTermCount

Output only. The number of GlossaryTerms in the Glossary.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCategoryCount

Output only. The number of GlossaryCategories in the Glossary.

Returns
Type
Description
int

setCategoryCount

Output only. The number of GlossaryCategories in the Glossary.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getEtag

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.

Returns
Type
Description
string

setEtag

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: