Class: OCI::Identity::Models::Region

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

Overview

A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers located within a region. For more information, see [Regions and Availability Domains](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Region

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :name (String) —

    The value to assign to the #name property



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/identity/models/region.rb', line 40

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

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

end

Instance Attribute Details

#key ⇒ String

The key of the region.

Allowed values are:

  • ‘PHX`

  • ‘IAD`

  • ‘FRA`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/identity/models/region.rb', line 23

def key
  @key
end

#name ⇒ String

The name of the region.

Allowed values are:

  • ‘us-phoenix-1`

  • ‘us-ashburn-1`

  • ‘eu-frankfurt-1`

Returns:

  • (String) 


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

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



58
59
60
61
62
63
 
# File 'lib/oci/identity/models/region.rb', line 58

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/identity/models/region.rb', line 80

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


67
68
69
 
# File 'lib/oci/identity/models/region.rb', line 67

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [key, name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/identity/models/region.rb', line 105

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



99
100
101
 
# File 'lib/oci/identity/models/region.rb', line 99

def to_s
  to_hash.to_s
end