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

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::GlossaryCategory.

A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

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

#description

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

#description=

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

#display_name

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

#display_name=

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

#labels

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

#labels=

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

#name

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

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
Returns
  • (::String) — Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.

#update_time

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