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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm).

Instance Attribute 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

  • :time_created (DateTime) —

    The value to assign to the #time_created property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/identity/models/tag.rb', line 76

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}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/identity/models/tag.rb', line 13

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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}“

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description you assign to the tag.

Returns:

  • (String) 


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

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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


42
43
44
 
# File 'lib/oci/identity/models/tag.rb', line 42

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the tag definition.

Returns:

  • (String) 


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

def id
  @id
end

#is_retired ⇒ BOOLEAN

[Required] Indicates whether the tag is retired. See [Retiring Key Definitions and Namespace Definitions](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).

Returns:

  • (BOOLEAN) 


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

def is_retired
  @is_retired
end

#name ⇒ String

[Required] The name of the tag. The name must be unique across all tags in the namespace and can’t be changed.

Returns:

  • (String) 


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

def name
  @name
end

#tag_namespace_id ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/tag.rb', line 17

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) 


22
23
24
 
# File 'lib/oci/identity/models/tag.rb', line 22

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) 


61
62
63
 
# File 'lib/oci/identity/models/tag.rb', line 61

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/identity/models/tag.rb', line 168

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      tag_namespace_id == other_object.tag_namespace_id &&
      tag_namespace_name == other_object.tag_namespace_name &&
      id == other_object.id &&
      name == other_object.name &&
      description == other_object.description &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags &&
      is_retired == other_object.is_retired &&
      time_created == other_object.time_created
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/identity/models/tag.rb', line 198

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/oci/identity/models/tag.rb', line 185

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/identity/models/tag.rb', line 191

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/identity/models/tag.rb', line 223

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



217
218
219
 
# File 'lib/oci/identity/models/tag.rb', line 217

def to_s
  to_hash.to_s
end