Class: OCI::Identity::Models::Region
- Inherits:
-
Object
- Object
- OCI::Identity::Models::Region
- 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.
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.
Instance Attribute Summary collapse
-
#key ⇒ String
The key of the region.
-
#name ⇒ String
The name of the region.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Region
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Region
Initializes the object
61 62 63 64 65 66 67 68 69 70 |
# File 'lib/oci/identity/models/region.rb', line 61 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 } self.key = attributes[:'key'] if attributes[:'key'] self.name = attributes[:'name'] if attributes[:'name'] end |
Instance Attribute Details
#key ⇒ String
The key of the region. See Regions and Availability Domains for the full list of supported 3-letter region codes.
Example: PHX
23 24 25 |
# File 'lib/oci/identity/models/region.rb', line 23 def key @key end |
#name ⇒ String
The name of the region. See Regions and Availability Domains for the full list of supported region names.
Example: us-phoenix-1
31 32 33 |
# File 'lib/oci/identity/models/region.rb', line 31 def name @name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
34 35 36 37 38 39 40 41 |
# File 'lib/oci/identity/models/region.rb', line 34 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'name': :'name' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
44 45 46 47 48 49 50 51 |
# File 'lib/oci/identity/models/region.rb', line 44 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'name': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
79 80 81 82 83 84 85 |
# File 'lib/oci/identity/models/region.rb', line 79 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && name == other.name end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/identity/models/region.rb', line 110 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) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? 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) ⇒ Boolean
90 91 92 |
# File 'lib/oci/identity/models/region.rb', line 90 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
99 100 101 |
# File 'lib/oci/identity/models/region.rb', line 99 def hash [key, name].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
143 144 145 146 147 148 149 150 151 152 |
# File 'lib/oci/identity/models/region.rb', line 143 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
137 138 139 |
# File 'lib/oci/identity/models/region.rb', line 137 def to_s to_hash.to_s end |