Class: Google::Cloud::Dataplex::V1::Glossary

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/business_glossary.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.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#category_count ⇒ ::Integer (readonly)

Returns Output only. The number of GlossaryCategories in the Glossary.

Returns:

  • (::Integer) —

    Output only. The number of GlossaryCategories in the Glossary.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. The user-mutable description of the Glossary.

Returns:

  • (::String) —

    Optional. The user-mutable description of the Glossary.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined labels for the Glossary.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for the Glossary.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#term_count ⇒ ::Integer (readonly)

Returns Output only. The number of GlossaryTerms in the Glossary.

Returns:

  • (::Integer) —

    Output only. The number of GlossaryTerms in the Glossary.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns 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:

  • (::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.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'proto_docs/google/cloud/dataplex/v1/business_glossary.rb', line 65

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end