Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Glossary

Returns a new instance of GoogleCloudDataplexV1Glossary.



5461
5462
5463
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5461

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

Instance Attribute Details

#category_count ⇒ Fixnum

Output only. The number of GlossaryCategories in the Glossary. Corresponds to the JSON property categoryCount

Returns:

  • (Fixnum) 


5408
5409
5410
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5408

def category_count
  @category_count
end

#create_time ⇒ String

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

Returns:

  • (String) 


5413
5414
5415
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5413

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


5418
5419
5420
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5418

def description
  @description
end

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

Returns:

  • (String) 


5424
5425
5426
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5424

def display_name
  @display_name
end

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

Returns:

  • (String) 


5432
5433
5434
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5432

def etag
  @etag
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


5437
5438
5439
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5437

def labels
  @labels
end

#name ⇒ String

Output only. Identifier. The resource name of the Glossary. Format: projects/ project_id_or_number/locations/location_id/glossaries/glossary_id Corresponds to the JSON property name

Returns:

  • (String) 


5443
5444
5445
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5443

def name
  @name
end

#term_count ⇒ Fixnum

Output only. The number of GlossaryTerms in the Glossary. Corresponds to the JSON property termCount

Returns:

  • (Fixnum) 


5448
5449
5450
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5448

def term_count
  @term_count
end

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

Returns:

  • (String) 


5454
5455
5456
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5454

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


5459
5460
5461
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5459

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5466

def update!(**args)
  @category_count = args[:category_count] if args.key?(:category_count)
  @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)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @term_count = args[:term_count] if args.key?(:term_count)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end