Class: OCI::Identity::Models::RegionSubscription
- Inherits:
-
Object
- Object
- OCI::Identity::Models::RegionSubscription
- Defined in:
- lib/oci/identity/models/region_subscription.rb
Overview
An object that represents your tenancy’s access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home region. For more information, see [Managing Regions](docs.cloud.oracle.com/Content/Identity/Tasks/managingregions.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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- STATUS_ENUM =
rubocop:disable Metrics/LineLength
[ STATUS_READY = 'READY'.freeze, STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze, STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#is_home_region ⇒ BOOLEAN
[Required] Indicates if the region is the home region or not.
-
#region_key ⇒ String
[Required] The region’s key.
-
#region_name ⇒ String
[Required] The region’s name.
-
#status ⇒ String
[Required] The region subscription status.
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 = {}) ⇒ RegionSubscription
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 = {}) ⇒ RegionSubscription
Initializes the object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/oci/identity/models/region_subscription.rb', line 86 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.region_key = attributes[:'regionKey'] if attributes[:'regionKey'] raise 'You cannot provide both :regionKey and :region_key' if attributes.key?(:'regionKey') && attributes.key?(:'region_key') self.region_key = attributes[:'region_key'] if attributes[:'region_key'] self.region_name = attributes[:'regionName'] if attributes[:'regionName'] raise 'You cannot provide both :regionName and :region_name' if attributes.key?(:'regionName') && attributes.key?(:'region_name') self.region_name = attributes[:'region_name'] if attributes[:'region_name'] self.status = attributes[:'status'] if attributes[:'status'] self.is_home_region = attributes[:'isHomeRegion'] unless attributes[:'isHomeRegion'].nil? raise 'You cannot provide both :isHomeRegion and :is_home_region' if attributes.key?(:'isHomeRegion') && attributes.key?(:'is_home_region') self.is_home_region = attributes[:'is_home_region'] unless attributes[:'is_home_region'].nil? end |
Instance Attribute Details
#is_home_region ⇒ BOOLEAN
[Required] Indicates if the region is the home region or not.
50 51 52 |
# File 'lib/oci/identity/models/region_subscription.rb', line 50 def is_home_region @is_home_region end |
#region_key ⇒ String
[Required] The region’s key.
Allowed values are:
-
‘PHX`
-
‘IAD`
-
‘FRA`
-
‘LHR`
31 32 33 |
# File 'lib/oci/identity/models/region_subscription.rb', line 31 def region_key @region_key end |
#region_name ⇒ String
[Required] The region’s name.
Allowed values are:
-
‘us-phoenix-1`
-
‘us-ashburn-1`
-
‘eu-frankurt-1`
-
‘uk-london-1`
42 43 44 |
# File 'lib/oci/identity/models/region_subscription.rb', line 42 def region_name @region_name end |
#status ⇒ String
[Required] The region subscription status.
46 47 48 |
# File 'lib/oci/identity/models/region_subscription.rb', line 46 def status @status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 |
# File 'lib/oci/identity/models/region_subscription.rb', line 53 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'region_key': :'regionKey', 'region_name': :'regionName', 'status': :'status', 'is_home_region': :'isHomeRegion' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 |
# File 'lib/oci/identity/models/region_subscription.rb', line 65 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'region_key': :'String', 'region_name': :'String', 'status': :'String', 'is_home_region': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
135 136 137 138 139 140 141 142 143 |
# File 'lib/oci/identity/models/region_subscription.rb', line 135 def ==(other) return true if equal?(other) self.class == other.class && region_key == other.region_key && region_name == other.region_name && status == other.status && is_home_region == other.is_home_region end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/oci/identity/models/region_subscription.rb', line 168 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
148 149 150 |
# File 'lib/oci/identity/models/region_subscription.rb', line 148 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
157 158 159 |
# File 'lib/oci/identity/models/region_subscription.rb', line 157 def hash [region_key, region_name, status, is_home_region].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/identity/models/region_subscription.rb', line 201 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
195 196 197 |
# File 'lib/oci/identity/models/region_subscription.rb', line 195 def to_s to_hash.to_s end |