Class: OCI::DataCatalog::Models::GlossarySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/glossary_summary.rb

Overview

Summary of a glossary. 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 catalog, 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

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GlossarySummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :display_name (String)

    The value to assign to the #display_name property

  • :catalog_id (String)

    The value to assign to the #catalog_id property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :description (String)

    The value to assign to the #description property

  • :uri (String)

    The value to assign to the #uri property

  • :workflow_status (String)

    The value to assign to the #workflow_status property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :import_job_definition_key (String)

    The value to assign to the #import_job_definition_key property

  • :import_job_key (String)

    The value to assign to the #import_job_key property

  • :latest_import_job_execution_key (String)

    The value to assign to the #latest_import_job_execution_key property

  • :latest_import_job_execution_status (String)

    The value to assign to the #latest_import_job_execution_status property



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
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
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 151

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.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.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.description = attributes[:'description'] if attributes[:'description']

  self.uri = attributes[:'uri'] if attributes[:'uri']

  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.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.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']
end

Instance Attribute Details

#catalog_idString

The data catalog's OCID.

Returns:

  • (String)


51
52
53
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 51

def catalog_id
  @catalog_id
end

#descriptionString

Detailed description of the glossary.

Returns:

  • (String)


61
62
63
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 61

def description
  @description
end

#display_nameString

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


47
48
49
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 47

def display_name
  @display_name
end

#import_job_definition_keyString

The unique key of the job definition resource that was used in the Glossary import.

Returns:

  • (String)


77
78
79
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 77

def import_job_definition_key
  @import_job_definition_key
end

#import_job_keyString

The unique key of the job policy for Glossary import.

Returns:

  • (String)


81
82
83
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 81

def import_job_key
  @import_job_key
end

#keyString

[Required] Unique glossary key that is immutable.

Returns:

  • (String)


41
42
43
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 41

def key
  @key
end

#latest_import_job_execution_keyString

The unique key of the parent job execution for which the log resource was created.

Returns:

  • (String)


85
86
87
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 85

def latest_import_job_execution_key
  @latest_import_job_execution_key
end

#latest_import_job_execution_statusString

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

Returns:

  • (String)


91
92
93
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 91

def latest_import_job_execution_status
  @latest_import_job_execution_status
end

#lifecycle_stateString

State of the Glossary.

Returns:

  • (String)


73
74
75
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

The date and time the glossary was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


57
58
59
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 57

def time_created
  @time_created
end

#uriString

URI to the glossary instance in the API.

Returns:

  • (String)


65
66
67
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 65

def uri
  @uri
end

#workflow_statusString

Status of the approval process workflow for this business glossary.

Returns:

  • (String)


69
70
71
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 69

def workflow_status
  @workflow_status
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'catalog_id': :'catalogId',
    'time_created': :'timeCreated',
    'description': :'description',
    'uri': :'uri',
    'workflow_status': :'workflowStatus',
    'lifecycle_state': :'lifecycleState',
    'import_job_definition_key': :'importJobDefinitionKey',
    'import_job_key': :'importJobKey',
    'latest_import_job_execution_key': :'latestImportJobExecutionKey',
    'latest_import_job_execution_status': :'latestImportJobExecutionStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'catalog_id': :'String',
    'time_created': :'DateTime',
    'description': :'String',
    'uri': :'String',
    'workflow_status': :'String',
    'lifecycle_state': :'String',
    'import_job_definition_key': :'String',
    'import_job_key': :'String',
    'latest_import_job_execution_key': :'String',
    'latest_import_job_execution_status': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 251

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    catalog_id == other.catalog_id &&
    time_created == other.time_created &&
    description == other.description &&
    uri == other.uri &&
    workflow_status == other.workflow_status &&
    lifecycle_state == other.lifecycle_state &&
    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
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 292

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

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 272

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



281
282
283
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 281

def hash
  [key, display_name, catalog_id, time_created, description, uri, workflow_status, lifecycle_state, import_job_definition_key, import_job_key, latest_import_job_execution_key, latest_import_job_execution_status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



325
326
327
328
329
330
331
332
333
334
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 325

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



319
320
321
# File 'lib/oci/data_catalog/models/glossary_summary.rb', line 319

def to_s
  to_hash.to_s
end