Class: OCI::DataCatalog::Models::GlossaryTreeElement

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

Overview

Glossary tree element with child terms.

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 = {}) ⇒ GlossaryTreeElement

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

  raise 'You cannot provide both :childTerms and :child_terms' if attributes.key?(:'childTerms') && attributes.key?(:'child_terms')

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

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

  raise 'You cannot provide both :glossaryKey and :glossary_key' if attributes.key?(:'glossaryKey') && attributes.key?(:'glossary_key')

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

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

  self.parent_term_key = attributes[:'parentTermKey'] if attributes[:'parentTermKey']

  raise 'You cannot provide both :parentTermKey and :parent_term_key' if attributes.key?(:'parentTermKey') && attributes.key?(:'parent_term_key')

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

  self.is_allowed_to_have_child_terms = attributes[:'isAllowedToHaveChildTerms'] unless attributes[:'isAllowedToHaveChildTerms'].nil?
  self.is_allowed_to_have_child_terms = true if is_allowed_to_have_child_terms.nil? && !attributes.key?(:'isAllowedToHaveChildTerms') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isAllowedToHaveChildTerms and :is_allowed_to_have_child_terms' if attributes.key?(:'isAllowedToHaveChildTerms') && attributes.key?(:'is_allowed_to_have_child_terms')

  self.is_allowed_to_have_child_terms = attributes[:'is_allowed_to_have_child_terms'] unless attributes[:'is_allowed_to_have_child_terms'].nil?
  self.is_allowed_to_have_child_terms = true if is_allowed_to_have_child_terms.nil? && !attributes.key?(:'isAllowedToHaveChildTerms') && !attributes.key?(:'is_allowed_to_have_child_terms') # rubocop:disable Style/StringLiterals

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

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

  raise 'You cannot provide both :associatedObjectCount and :associated_object_count' if attributes.key?(:'associatedObjectCount') && attributes.key?(:'associated_object_count')

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

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

Instance Attribute Details

#associated_object_count ⇒ Integer

The number of objects tagged with this term.

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 82

def associated_object_count
  @associated_object_count
end

#child_terms ⇒ Array<OCI::DataCatalog::Models::GlossaryTreeElement>

An array of child terms.

Returns:



34
35
36
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 34

def child_terms
  @child_terms
end

#description ⇒ String

Detailed description of the term.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 48

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.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 44

def display_name
  @display_name
end

#glossary_key ⇒ String

Unique id of the parent glossary.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 52

def glossary_key
  @glossary_key
end

#is_allowed_to_have_child_terms ⇒ BOOLEAN

Indicates whether a term may contain child terms.

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 64

def is_allowed_to_have_child_terms
  @is_allowed_to_have_child_terms
end

#key ⇒ String

[Required] Unique term key that is immutable.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 38

def key
  @key
end

#lifecycle_state ⇒ String

State of the term.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 86

def lifecycle_state
  @lifecycle_state
end

#parent_term_key ⇒ String

This terms parent term key. Will be null if the term has no parent term.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 60

def parent_term_key
  @parent_term_key
end

#path ⇒ String

Absolute path of the term.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 68

def path
  @path
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 74

def time_created
  @time_created
end

#uri ⇒ String

URI to the term instance in the API.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 56

def uri
  @uri
end

#workflow_status ⇒ String

Status of the approval process workflow for this business term in the glossary.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 78

def workflow_status
  @workflow_status
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'child_terms': :'childTerms',
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'glossary_key': :'glossaryKey',
    'uri': :'uri',
    'parent_term_key': :'parentTermKey',
    'is_allowed_to_have_child_terms': :'isAllowedToHaveChildTerms',
    'path': :'path',
    'time_created': :'timeCreated',
    'workflow_status': :'workflowStatus',
    'associated_object_count': :'associatedObjectCount',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'child_terms': :'Array<OCI::DataCatalog::Models::GlossaryTreeElement>',
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'glossary_key': :'String',
    'uri': :'String',
    'parent_term_key': :'String',
    'is_allowed_to_have_child_terms': :'BOOLEAN',
    'path': :'String',
    'time_created': :'DateTime',
    'workflow_status': :'String',
    'associated_object_count': :'Integer',
    'lifecycle_state': :'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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 253

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

  self.class == other.class &&
    child_terms == other.child_terms &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    glossary_key == other.glossary_key &&
    uri == other.uri &&
    parent_term_key == other.parent_term_key &&
    is_allowed_to_have_child_terms == other.is_allowed_to_have_child_terms &&
    path == other.path &&
    time_created == other.time_created &&
    workflow_status == other.workflow_status &&
    associated_object_count == other.associated_object_count &&
    lifecycle_state == other.lifecycle_state
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



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

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


275
276
277
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 284

def hash
  [child_terms, key, display_name, description, glossary_key, uri, parent_term_key, is_allowed_to_have_child_terms, path, time_created, workflow_status, associated_object_count, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 328

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

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/oci/data_catalog/models/glossary_tree_element.rb', line 322

def to_s
  to_hash.to_s
end