Class: OCI::DataCatalog::Models::BaseTagSummary

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

Overview

Represents the association of an object to a term.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseTagSummary

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

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :name (String)

    The value to assign to the #name property

  • :uri (String)

    The value to assign to the #uri property

  • :term_key (String)

    The value to assign to the #term_key property

  • :term_path (String)

    The value to assign to the #term_path property

  • :term_description (String)

    The value to assign to the #term_description property

  • :glossary_key (String)

    The value to assign to the #glossary_key property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 108

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

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

  self.term_key = attributes[:'termKey'] if attributes[:'termKey']

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

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

  self.term_path = attributes[:'termPath'] if attributes[:'termPath']

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

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

  self.term_description = attributes[:'termDescription'] if attributes[:'termDescription']

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

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

#glossary_keyString

Unique id of the parent glossary of the term.

Returns:

  • (String)


53
54
55
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 53

def glossary_key
  @glossary_key
end

#keyString

[Required] Unique tag key that is immutable.

Returns:

  • (String)


23
24
25
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 23

def key
  @key
end

#lifecycle_stateString

State of the Tag.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#nameString

Name of the tag that matches the term name.

Returns:

  • (String)


33
34
35
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 33

def name
  @name
end

#term_descriptionString

Description of the related term.

Returns:

  • (String)


49
50
51
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 49

def term_description
  @term_description
end

#term_keyString

Unique key of the related term.

Returns:

  • (String)


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

def term_key
  @term_key
end

#term_pathString

Path of the related term.

Returns:

  • (String)


45
46
47
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 45

def term_path
  @term_path
end

#time_createdDateTime

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

Returns:

  • (DateTime)


29
30
31
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 29

def time_created
  @time_created
end

#uriString

URI to the tag instance in the API.

Returns:

  • (String)


37
38
39
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 37

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'time_created': :'timeCreated',
    'name': :'name',
    'uri': :'uri',
    'term_key': :'termKey',
    'term_path': :'termPath',
    'term_description': :'termDescription',
    'glossary_key': :'glossaryKey',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'time_created': :'DateTime',
    'name': :'String',
    'uri': :'String',
    'term_key': :'String',
    'term_path': :'String',
    'term_description': :'String',
    'glossary_key': :'String',
    '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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 172

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

  self.class == other.class &&
    key == other.key &&
    time_created == other.time_created &&
    name == other.name &&
    uri == other.uri &&
    term_key == other.term_key &&
    term_path == other.term_path &&
    term_description == other.term_description &&
    glossary_key == other.glossary_key &&
    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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 210

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


190
191
192
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 190

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



199
200
201
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 199

def hash
  [key, time_created, name, uri, term_key, term_path, term_description, glossary_key, lifecycle_state].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 243

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



237
238
239
# File 'lib/oci/data_catalog/models/base_tag_summary.rb', line 237

def to_s
  to_hash.to_s
end