Class: OCI::Identity::Models::Tenancy

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tenancy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



44
45
46
47
48
49
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
 
# File 'lib/oci/identity/models/tenancy.rb', line 44

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

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

  if attributes[:'homeRegionKey']
    self.home_region_key = attributes[:'homeRegionKey']
  end

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

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

end

Instance Attribute Details

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the tenancy.

Returns:

  • (String) 


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

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


33
34
35
 
# File 'lib/oci/identity/models/tenancy.rb', line 33

def freeform_tags
  @freeform_tags
end

#home_region_key ⇒ String

The region key for the tenancy’s home region.

Allowed values are:

  • ‘IAD`

  • ‘PHX`

  • ‘FRA`

Returns:

  • (String) 


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

def home_region_key
  @home_region_key
end

#id ⇒ String

The OCID of the tenancy.

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String

The name of the tenancy.

Returns:

  • (String) 


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

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/identity/models/tenancy.rb', line 78

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/identity/models/tenancy.rb', line 104

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


91
92
93
 
# File 'lib/oci/identity/models/tenancy.rb', line 91

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



97
98
99
 
# File 'lib/oci/identity/models/tenancy.rb', line 97

def hash
  [id, name, description, home_region_key, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/identity/models/tenancy.rb', line 129

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



123
124
125
 
# File 'lib/oci/identity/models/tenancy.rb', line 123

def to_s
  to_hash.to_s
end