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](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm).

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



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
219
220
221
222
223
 
# File 'lib/oci/identity/models/tag.rb', line 156

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_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}“

Returns:

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


63
64
65
 
# File 'lib/oci/identity/models/tag.rb', line 63

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description you assign to the tag.

Returns:

  • (String) 


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

def description
  @description
end

#freeform_tags ⇒ Hash<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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


56
57
58
 
# File 'lib/oci/identity/models/tag.rb', line 56

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the tag definition.

Returns:

  • (String) 


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

def id
  @id
end

#is_cost_tracking ⇒ BOOLEAN

Indicates whether the tag is enabled for cost tracking.

Returns:

  • (BOOLEAN) 


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

def is_cost_tracking
  @is_cost_tracking
end

#is_retired ⇒ BOOLEAN

[Required] Indicates whether the tag is retired. See [Retiring Key Definitions and Namespace Definitions](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).

Returns:

  • (BOOLEAN) 


69
70
71
 
# File 'lib/oci/identity/models/tag.rb', line 69

def is_retired
  @is_retired
end

#lifecycle_state ⇒ String

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) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[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) 


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

def name
  @name
end

#tag_namespace_id ⇒ String

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

Returns:

  • (String) 


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

def tag_namespace_id
  @tag_namespace_id
end

#tag_namespace_name ⇒ String

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

Returns:

  • (String) 


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

def tag_namespace_name
  @tag_namespace_name
end

#time_created ⇒ DateTime

[Required] Date and time the tag was created, in the format defined by RFC3339. Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/identity/models/tag.rb', line 79

def time_created
  @time_created
end

#validator ⇒ OCI::Identity::Models::BaseTagDefinitionValidator

Additional validation rule for values specified for the tag definition.

If no validator is defined for a tag definition, then any (valid) value will be accepted.

To clear the validator call the UPDATE operation with DefaultTagDefinitionValidator

Returns:



93
94
95
 
# File 'lib/oci/identity/models/tag.rb', line 93

def validator
  @validator
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/identity/models/tag.rb', line 96

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_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/identity/models/tag.rb', line 117

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/identity/models/tag.rb', line 245

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/identity/models/tag.rb', line 287

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


267
268
269
 
# File 'lib/oci/identity/models/tag.rb', line 267

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/identity/models/tag.rb', line 320

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



314
315
316
 
# File 'lib/oci/identity/models/tag.rb', line 314

def to_s
  to_hash.to_s
end