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

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

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
 
# File 'lib/oci/identity/models/tag.rb', line 59

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

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

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

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

  if attributes[:'isRetired']
    self.is_retired = attributes[:'isRetired']
  end

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

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment which the tagRule belongs to.

Returns:

  • (String) 


9
10
11
 
# File 'lib/oci/identity/models/tag.rb', line 9

def compartment_id
  @compartment_id
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the tag.

Returns:

  • (String) 


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

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: ‘"value"`

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the tag definition.

Returns:

  • (String) 


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

def id
  @id
end

#is_retired ⇒ BOOLEAN

Indicated whether the tagNamespace is retired or not

Returns:

  • (BOOLEAN) 


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

def is_retired
  @is_retired
end

#name ⇒ String

The name of the tag which must be unique across all tags in the tagNamespace and cannot be changed.

Returns:

  • (String) 


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

def name
  @name
end

#tag_namespace_id ⇒ String

The OCID of the containing tagNamespace.

Returns:

  • (String) 


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

def tag_namespace_id
  @tag_namespace_id
end

#tag_namespace_name ⇒ String

The name of the tag namespace to which this tag belongs.

Returns:

  • (String) 


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

def tag_namespace_name
  @tag_namespace_name
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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



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

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/identity/models/tag.rb', line 139

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


126
127
128
 
# File 'lib/oci/identity/models/tag.rb', line 126

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/oci/identity/models/tag.rb', line 132

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



164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/identity/models/tag.rb', line 164

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



158
159
160
 
# File 'lib/oci/identity/models/tag.rb', line 158

def to_s
  to_hash.to_s
end