Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Glossary (v2.6.0)

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#category_count

def category_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of GlossaryCategories in the Glossary.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The user-mutable description of the Glossary.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The user-mutable description of the Glossary.
Returns
  • (::String) — Optional. The user-mutable description of the Glossary.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
Returns
  • (::String) — Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.

#etag

def etag() -> ::String
Returns
  • (::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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the Glossary.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the Glossary.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the Glossary.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}

#term_count

def term_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of GlossaryTerms in the Glossary.

#uid

def uid() -> ::String
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns