Class: OCI::Identity::Models::Tag

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/tag.rb

Overview

A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before you can apply them to resources. For more information, see Managing Tags and Tag Namespaces.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ Tag

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :tag_namespace_id (String)

    The value to assign to the #tag_namespace_id property

  • :tag_namespace_name (String)

    The value to assign to the #tag_namespace_name property

  • :id (String)

    The value to assign to the #id property

  • :name (String)

    The value to assign to the #name property

  • :description (String)

    The value to assign to the #description property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property

  • :is_retired (BOOLEAN)

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

  • :is_cost_tracking (BOOLEAN)

    The value to assign to the #is_cost_tracking property

  • :validator (OCI::Identity::Models::BaseTagDefinitionValidator)

    The value to assign to the #validator property



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/oci/identity/models/tag.rb', line 165

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

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

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

  self.tag_namespace_id = attributes[:'tagNamespaceId'] if attributes[:'tagNamespaceId']

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

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

  self.tag_namespace_name = attributes[:'tagNamespaceName'] if attributes[:'tagNamespaceName']

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

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.is_retired = attributes[:'isRetired'] unless attributes[:'isRetired'].nil?

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

  self.is_retired = attributes[:'is_retired'] unless attributes[:'is_retired'].nil?

  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.is_cost_tracking = attributes[:'isCostTracking'] unless attributes[:'isCostTracking'].nil?

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

  self.is_cost_tracking = attributes[:'is_cost_tracking'] unless attributes[:'is_cost_tracking'].nil?

  self.validator = attributes[:'validator'] if attributes[:'validator']
end

Instance Attribute Details

#compartment_idString

[Required] The OCID of the compartment that contains the tag definition.

Returns:

  • (String)


27
28
29
# File 'lib/oci/identity/models/tag.rb', line 27

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


66
67
68
# File 'lib/oci/identity/models/tag.rb', line 66

def defined_tags
  @defined_tags
end

#descriptionString

[Required] The description you assign to the tag.

Returns:

  • (String)


50
51
52
# File 'lib/oci/identity/models/tag.rb', line 50

def description
  @description
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


58
59
60
# File 'lib/oci/identity/models/tag.rb', line 58

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the tag definition.

Returns:

  • (String)


40
41
42
# File 'lib/oci/identity/models/tag.rb', line 40

def id
  @id
end

#is_cost_trackingBOOLEAN

Indicates whether the tag is enabled for cost tracking.

Returns:

  • (BOOLEAN)


88
89
90
# File 'lib/oci/identity/models/tag.rb', line 88

def is_cost_tracking
  @is_cost_tracking
end

#is_retiredBOOLEAN

[Required] Indicates whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.

Returns:

  • (BOOLEAN)


72
73
74
# File 'lib/oci/identity/models/tag.rb', line 72

def is_retired
  @is_retired
end

#lifecycle_stateString

The tag's current state. After creating a tag, make sure its lifecycleState is ACTIVE before using it. After retiring a tag, make sure its lifecycleState is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's lifecycleState changes from DELETING to DELETED.

Returns:

  • (String)


76
77
78
# File 'lib/oci/identity/models/tag.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#nameString

[Required] The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed.

Returns:

  • (String)


46
47
48
# File 'lib/oci/identity/models/tag.rb', line 46

def name
  @name
end

#tag_namespace_idString

[Required] The OCID of the namespace that contains the tag definition.

Returns:

  • (String)


31
32
33
# File 'lib/oci/identity/models/tag.rb', line 31

def tag_namespace_id
  @tag_namespace_id
end

#tag_namespace_nameString

[Required] The name of the tag namespace that contains the tag definition.

Returns:

  • (String)


36
37
38
# File 'lib/oci/identity/models/tag.rb', line 36

def tag_namespace_name
  @tag_namespace_name
end

#time_createdDateTime

[Required] Date and time the tag was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


83
84
85
# File 'lib/oci/identity/models/tag.rb', line 83

def time_created
  @time_created
end

#validatorOCI::Identity::Models::BaseTagDefinitionValidator

The tag must have a value type, which is specified with a validator. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. Lists are validiated.

If you use the default validiator (or don't define a validator), the user applying the tag enters a value. No additional validation is performed.

To clear the validator, call UpdateTag with DefaultTagDefinitionValidator.



102
103
104
# File 'lib/oci/identity/models/tag.rb', line 102

def validator
  @validator
end

Class Method Details

.attribute_mapObject

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/oci/identity/models/tag.rb', line 105

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'tag_namespace_id': :'tagNamespaceId',
    'tag_namespace_name': :'tagNamespaceName',
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'is_retired': :'isRetired',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'is_cost_tracking': :'isCostTracking',
    'validator': :'validator'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/oci/identity/models/tag.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'tag_namespace_id': :'String',
    'tag_namespace_name': :'String',
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'is_retired': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'is_cost_tracking': :'BOOLEAN',
    'validator': :'OCI::Identity::Models::BaseTagDefinitionValidator'
    # 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



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

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    tag_namespace_id == other.tag_namespace_id &&
    tag_namespace_name == other.tag_namespace_name &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    is_retired == other.is_retired &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    is_cost_tracking == other.is_cost_tracking &&
    validator == other.validator
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



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

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


276
277
278
# File 'lib/oci/identity/models/tag.rb', line 276

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



285
286
287
# File 'lib/oci/identity/models/tag.rb', line 285

def hash
  [compartment_id, tag_namespace_id, tag_namespace_name, id, name, description, freeform_tags, defined_tags, is_retired, lifecycle_state, time_created, is_cost_tracking, validator].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
338
# File 'lib/oci/identity/models/tag.rb', line 329

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



323
324
325
# File 'lib/oci/identity/models/tag.rb', line 323

def to_s
  to_hash.to_s
end