Class: OCI::DataCatalog::Models::Glossary
- Inherits:
-
Object
- Object
- OCI::DataCatalog::Models::Glossary
- Defined in:
- lib/oci/data_catalog/models/glossary.rb
Overview
Full glossary details. A glossary of business terms, such as 'Customer', 'Account', 'Contact' , 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.
Instance Attribute Summary collapse
-
#catalog_id ⇒ String
The data catalog's OCID.
-
#created_by_id ⇒ String
OCID of the user who created this metadata element.
-
#description ⇒ String
Detailed description of the glossary.
-
#display_name ⇒ String
A user-friendly display name.
-
#key ⇒ String
[Required] Unique glossary key that is immutable.
-
#lifecycle_state ⇒ String
The current state of the glossary.
-
#owner ⇒ String
OCID of the user who is the owner of the glossary.
-
#time_created ⇒ DateTime
The date and time the glossary was created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
The last time that any change was made to the glossary.
-
#updated_by_id ⇒ String
OCID of the user who updated this metadata element.
-
#uri ⇒ String
URI to the tag instance in the API.
-
#workflow_status ⇒ String
Status of the approval process workflow for this business glossary.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Glossary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Glossary
Initializes the object
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 129 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.key = attributes[:'key'] if attributes[:'key'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.description = attributes[:'description'] if attributes[:'description'] self.catalog_id = attributes[:'catalogId'] if attributes[:'catalogId'] raise 'You cannot provide both :catalogId and :catalog_id' if attributes.key?(:'catalogId') && attributes.key?(:'catalog_id') self.catalog_id = attributes[:'catalog_id'] if attributes[:'catalog_id'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.created_by_id = attributes[:'createdById'] if attributes[:'createdById'] raise 'You cannot provide both :createdById and :created_by_id' if attributes.key?(:'createdById') && attributes.key?(:'created_by_id') self.created_by_id = attributes[:'created_by_id'] if attributes[:'created_by_id'] self.updated_by_id = attributes[:'updatedById'] if attributes[:'updatedById'] raise 'You cannot provide both :updatedById and :updated_by_id' if attributes.key?(:'updatedById') && attributes.key?(:'updated_by_id') self.updated_by_id = attributes[:'updated_by_id'] if attributes[:'updated_by_id'] self.owner = attributes[:'owner'] if attributes[:'owner'] self.workflow_status = attributes[:'workflowStatus'] if attributes[:'workflowStatus'] raise 'You cannot provide both :workflowStatus and :workflow_status' if attributes.key?(:'workflowStatus') && attributes.key?(:'workflow_status') self.workflow_status = attributes[:'workflow_status'] if attributes[:'workflow_status'] self.uri = attributes[:'uri'] if attributes[:'uri'] end |
Instance Attribute Details
#catalog_id ⇒ String
The data catalog's OCID.
34 35 36 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 34 def catalog_id @catalog_id end |
#created_by_id ⇒ String
OCID of the user who created this metadata element.
53 54 55 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 53 def created_by_id @created_by_id end |
#description ⇒ String
Detailed description of the glossary.
30 31 32 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 30 def description @description end |
#display_name ⇒ String
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
26 27 28 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 26 def display_name @display_name end |
#key ⇒ String
[Required] Unique glossary key that is immutable.
20 21 22 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 20 def key @key end |
#lifecycle_state ⇒ String
The current state of the glossary.
38 39 40 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 38 def lifecycle_state @lifecycle_state end |
#owner ⇒ String
OCID of the user who is the owner of the glossary.
61 62 63 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 61 def owner @owner end |
#time_created ⇒ DateTime
The date and time the glossary was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
44 45 46 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 44 def time_created @time_created end |
#time_updated ⇒ DateTime
The last time that any change was made to the glossary. An RFC3339 formatted datetime string.
49 50 51 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 49 def time_updated @time_updated end |
#updated_by_id ⇒ String
OCID of the user who updated this metadata element.
57 58 59 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 57 def updated_by_id @updated_by_id end |
#uri ⇒ String
URI to the tag instance in the API.
69 70 71 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 69 def uri @uri end |
#workflow_status ⇒ String
Status of the approval process workflow for this business glossary.
65 66 67 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 65 def workflow_status @workflow_status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 72 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'display_name': :'displayName', 'description': :'description', 'catalog_id': :'catalogId', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'created_by_id': :'createdById', 'updated_by_id': :'updatedById', 'owner': :'owner', 'workflow_status': :'workflowStatus', 'uri': :'uri' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 92 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'display_name': :'String', 'description': :'String', 'catalog_id': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'created_by_id': :'String', 'updated_by_id': :'String', 'owner': :'String', 'workflow_status': :'String', 'uri': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 199 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && display_name == other.display_name && description == other.description && catalog_id == other.catalog_id && lifecycle_state == other.lifecycle_state && time_created == other.time_created && time_updated == other.time_updated && created_by_id == other.created_by_id && updated_by_id == other.updated_by_id && owner == other.owner && workflow_status == other.workflow_status && uri == other.uri end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 240 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
220 221 222 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 220 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
229 230 231 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 229 def hash [key, display_name, description, catalog_id, lifecycle_state, time_created, time_updated, created_by_id, updated_by_id, owner, workflow_status, uri].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
273 274 275 276 277 278 279 280 281 282 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 273 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
267 268 269 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 267 def to_s to_hash.to_s end |