Class: OCI::DataCatalog::Models::BaseTag

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

Overview

Represents the association of an object to a term. Tags are immutable.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseTag

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

  • :name (String) —

    The value to assign to the #name 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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :created_by_id (String) —

    The value to assign to the #created_by_id property

  • :uri (String) —

    The value to assign to the #uri property



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
156
157
158
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 111

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

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

Instance Attribute Details

#created_by_id ⇒ String

OCID of the user who created the tag.

Returns:

  • (String) 


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

def created_by_id
  @created_by_id
end

#key ⇒ String

[Required] Unique tag key that is immutable.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 26

def key
  @key
end

#lifecycle_state ⇒ String

The current state of the tag.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

Name of the tag which matches the term name.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 30

def name
  @name
end

#term_description ⇒ String

Description of the related term.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 42

def term_description
  @term_description
end

#term_key ⇒ String

Unique key of the related term.

Returns:

  • (String) 


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

def term_key
  @term_key
end

#term_path ⇒ String

Path of the related term.

Returns:

  • (String) 


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

def term_path
  @term_path
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#uri ⇒ String

URI to the tag instance in the API.

Returns:

  • (String) 


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

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 63

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

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 80

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 180

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

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 218

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


198
199
200
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 207

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 251

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



245
246
247
 
# File 'lib/oci/data_catalog/models/base_tag.rb', line 245

def to_s
  to_hash.to_s
end