Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1GlossaryCategory

Returns a new instance of GoogleCloudDataplexV1GlossaryCategory.



5534
5535
5536
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5534

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the GlossaryCategory was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


5488
5489
5490
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5488

def create_time
  @create_time
end

#description ⇒ String

Optional. The user-mutable description of the GlossaryCategory. Corresponds to the JSON property description

Returns:

  • (String) 


5493
5494
5495
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5493

def description
  @description
end

#display_name ⇒ String

Optional. User friendly display name of the GlossaryCategory. This is user- mutable. This will be same as the GlossaryCategoryId, if not specified. Corresponds to the JSON property displayName

Returns:

  • (String) 


5499
5500
5501
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5499

def display_name
  @display_name
end

#labels ⇒ Hash<String,String>

Optional. User-defined labels for the GlossaryCategory. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


5504
5505
5506
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5504

def labels
  @labels
end

#name ⇒ 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 Corresponds to the JSON property name

Returns:

  • (String) 


5511
5512
5513
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5511

def name
  @name
end

#parent ⇒ 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 Corresponds to the JSON property parent

Returns:

  • (String) 


5520
5521
5522
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5520

def parent
  @parent
end

#uid ⇒ 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. Corresponds to the JSON property uid

Returns:

  • (String) 


5527
5528
5529
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5527

def uid
  @uid
end

#update_time ⇒ String

Output only. The time at which the GlossaryCategory was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5532
5533
5534
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5532

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5539

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end