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.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_MOVING = 'MOVING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- WORKFLOW_STATUS_ENUM =
[ WORKFLOW_STATUS_NEW = 'NEW'.freeze, WORKFLOW_STATUS_APPROVED = 'APPROVED'.freeze, WORKFLOW_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'.freeze, WORKFLOW_STATUS_ESCALATED = 'ESCALATED'.freeze, WORKFLOW_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
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.
-
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>
The list of customized properties along with the values for this object.
-
#description ⇒ String
Detailed description of the glossary.
-
#display_name ⇒ String
A user-friendly display name.
-
#import_job_definition_key ⇒ String
The unique key of the job definition resource that was used in the Glossary import.
-
#import_job_key ⇒ String
The unique key of the job policy for Glossary import.
-
#key ⇒ String
[Required] Unique glossary key that is immutable.
-
#latest_import_job_execution_key ⇒ String
The unique key of the parent job execution for which the log resource was created.
-
#latest_import_job_execution_status ⇒ String
Status of the latest glossary import job execution, such as running, paused, or completed.
-
#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
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 188 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.custom_property_members = attributes[:'customPropertyMembers'] if attributes[:'customPropertyMembers'] raise 'You cannot provide both :customPropertyMembers and :custom_property_members' if attributes.key?(:'customPropertyMembers') && attributes.key?(:'custom_property_members') self.custom_property_members = attributes[:'custom_property_members'] if attributes[:'custom_property_members'] self.import_job_definition_key = attributes[:'importJobDefinitionKey'] if attributes[:'importJobDefinitionKey'] raise 'You cannot provide both :importJobDefinitionKey and :import_job_definition_key' if attributes.key?(:'importJobDefinitionKey') && attributes.key?(:'import_job_definition_key') self.import_job_definition_key = attributes[:'import_job_definition_key'] if attributes[:'import_job_definition_key'] self.import_job_key = attributes[:'importJobKey'] if attributes[:'importJobKey'] raise 'You cannot provide both :importJobKey and :import_job_key' if attributes.key?(:'importJobKey') && attributes.key?(:'import_job_key') self.import_job_key = attributes[:'import_job_key'] if attributes[:'import_job_key'] self.latest_import_job_execution_key = attributes[:'latestImportJobExecutionKey'] if attributes[:'latestImportJobExecutionKey'] raise 'You cannot provide both :latestImportJobExecutionKey and :latest_import_job_execution_key' if attributes.key?(:'latestImportJobExecutionKey') && attributes.key?(:'latest_import_job_execution_key') self.latest_import_job_execution_key = attributes[:'latest_import_job_execution_key'] if attributes[:'latest_import_job_execution_key'] self.latest_import_job_execution_status = attributes[:'latestImportJobExecutionStatus'] if attributes[:'latestImportJobExecutionStatus'] raise 'You cannot provide both :latestImportJobExecutionStatus and :latest_import_job_execution_status' if attributes.key?(:'latestImportJobExecutionStatus') && attributes.key?(:'latest_import_job_execution_status') self.latest_import_job_execution_status = attributes[:'latest_import_job_execution_status'] if attributes[:'latest_import_job_execution_status'] self.uri = attributes[:'uri'] if attributes[:'uri'] end |
Instance Attribute Details
#catalog_id ⇒ String
The data catalog's OCID.
56 57 58 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 56 def catalog_id @catalog_id end |
#created_by_id ⇒ String
OCID of the user who created this metadata element.
75 76 77 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 75 def created_by_id @created_by_id end |
#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>
The list of customized properties along with the values for this object
91 92 93 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 91 def custom_property_members @custom_property_members end |
#description ⇒ String
Detailed description of the glossary.
52 53 54 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 52 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.
48 49 50 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 48 def display_name @display_name end |
#import_job_definition_key ⇒ String
The unique key of the job definition resource that was used in the Glossary import.
95 96 97 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 95 def import_job_definition_key @import_job_definition_key end |
#import_job_key ⇒ String
The unique key of the job policy for Glossary import.
99 100 101 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 99 def import_job_key @import_job_key end |
#key ⇒ String
[Required] Unique glossary key that is immutable.
42 43 44 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 42 def key @key end |
#latest_import_job_execution_key ⇒ String
The unique key of the parent job execution for which the log resource was created.
103 104 105 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 103 def latest_import_job_execution_key @latest_import_job_execution_key end |
#latest_import_job_execution_status ⇒ String
Status of the latest glossary import job execution, such as running, paused, or completed. This may include additional information like time import started , import file size and % of completion
109 110 111 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 109 def latest_import_job_execution_status @latest_import_job_execution_status end |
#lifecycle_state ⇒ String
The current state of the glossary.
60 61 62 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 60 def lifecycle_state @lifecycle_state end |
#owner ⇒ String
OCID of the user who is the owner of the glossary.
83 84 85 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 83 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
66 67 68 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 66 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.
71 72 73 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 71 def time_updated @time_updated end |
#updated_by_id ⇒ String
OCID of the user who updated this metadata element.
79 80 81 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 79 def updated_by_id @updated_by_id end |
#uri ⇒ String
URI to the tag instance in the API.
113 114 115 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 113 def uri @uri end |
#workflow_status ⇒ String
Status of the approval process workflow for this business glossary.
87 88 89 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 87 def workflow_status @workflow_status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 116 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', 'custom_property_members': :'customPropertyMembers', 'import_job_definition_key': :'importJobDefinitionKey', 'import_job_key': :'importJobKey', 'latest_import_job_execution_key': :'latestImportJobExecutionKey', 'latest_import_job_execution_status': :'latestImportJobExecutionStatus', 'uri': :'uri' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 141 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', 'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>', 'import_job_definition_key': :'String', 'import_job_key': :'String', 'latest_import_job_execution_key': :'String', 'latest_import_job_execution_status': :'String', 'uri': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 314 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 && custom_property_members == other.custom_property_members && import_job_definition_key == other.import_job_definition_key && import_job_key == other.import_job_key && latest_import_job_execution_key == other.latest_import_job_execution_key && latest_import_job_execution_status == other.latest_import_job_execution_status && uri == other.uri end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 360 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
340 341 342 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 340 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
349 350 351 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 349 def hash [key, display_name, description, catalog_id, lifecycle_state, time_created, time_updated, created_by_id, updated_by_id, owner, workflow_status, custom_property_members, import_job_definition_key, import_job_key, latest_import_job_execution_key, latest_import_job_execution_status, uri].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
393 394 395 396 397 398 399 400 401 402 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 393 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
387 388 389 |
# File 'lib/oci/data_catalog/models/glossary.rb', line 387 def to_s to_hash.to_s end |