Class: OCI::DataCatalog::Models::EntityTag

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

Overview

Represents an association of an entity 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,
  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 = {}) ⇒ EntityTag

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :entity_key (String)

    The value to assign to the #entity_key property

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



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
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 117

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

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

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

  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_idString

OCID of the user who created the tag.

Returns:

  • (String)


59
60
61
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 59

def created_by_id
  @created_by_id
end

#entity_keyString

The unique key of the parent entity.

Returns:

  • (String)


25
26
27
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 25

def entity_key
  @entity_key
end

#keyString

[Required] Unique tag key that is immutable.

Returns:

  • (String)


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

def key
  @key
end

#lifecycle_stateString

The current state of the tag.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#nameString

Name of the tag which matches the term name.

Returns:

  • (String)


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

def name
  @name
end

#term_descriptionString

Description of the related term.

Returns:

  • (String)


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

def term_description
  @term_description
end

#term_keyString

Unique key of the related term.

Returns:

  • (String)


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

def term_key
  @term_key
end

#term_pathString

Path of the related term.

Returns:

  • (String)


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

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)


55
56
57
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 55

def time_created
  @time_created
end

#uriString

URI to the tag instance in the API.

Returns:

  • (String)


63
64
65
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 63

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_key': :'entityKey',
    '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_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_key': :'String',
    '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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 192

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

  self.class == other.class &&
    entity_key == other.entity_key &&
    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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 231

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


211
212
213
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 211

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



220
221
222
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 220

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 264

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



258
259
260
# File 'lib/oci/data_catalog/models/entity_tag.rb', line 258

def to_s
  to_hash.to_s
end