Class: OCI::Identity::Models::TagNamespace

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TagNamespace

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
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
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 50

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[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  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 namespace is attached to.

Returns:

  • (String) 


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

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


34
35
36
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 34

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the tagNamespace.

Returns:

  • (String) 


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

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


28
29
30
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 28

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the tagNamespace.

Returns:

  • (String) 


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

def id
  @id
end

#is_retired ⇒ BOOLEAN

Indicated whether or not the tagNamespace is retired

Returns:

  • (BOOLEAN) 


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

def is_retired
  @is_retired
end

#name ⇒ String

The name of the tagNamespace. It must be unique across all tagNamespaces in the tenancy and cannot be changed.

Returns:

  • (String) 


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

def name
  @name
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 92

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_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



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

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


107
108
109
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 107

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 113

def hash
  [id, compartment_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



145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 145

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



139
140
141
 
# File 'lib/oci/identity/models/tag_namespace.rb', line 139

def to_s
  to_hash.to_s
end