Class: OCI::Identity::Models::RegionSubscription

Inherits:
Object
  • Object
show all
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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

STATUS_ENUM = 
[STATUS_READY = 'READY',
STATUS_IN_PROGRESS = 'IN_PROGRESS',
STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RegionSubscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :region_key (String) —

    The value to assign to the #region_key property

  • :region_name (String) —

    The value to assign to the #region_name property

  • :status (String) —

    The value to assign to the #status property

  • :is_home_region (BOOLEAN) —

    The value to assign to the #is_home_region property



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
89
90
91
92
93
94
95
96
 
# File 'lib/oci/identity/models/region_subscription.rb', line 56

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

  raise 'You cannot provide both :regionKey and :region_key' if attributes.key?(:'regionKey') && attributes.key?(:'region_key')

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

  if attributes[:'regionName']
    self.region_name = attributes[:'regionName']
  end

  raise 'You cannot provide both :regionName and :region_name' if attributes.key?(:'regionName') && attributes.key?(:'region_name')

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

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

  unless attributes[:'isHomeRegion'].nil?
    self.is_home_region = attributes[:'isHomeRegion']
  end

  raise 'You cannot provide both :isHomeRegion and :is_home_region' if attributes.key?(:'isHomeRegion') && attributes.key?(:'is_home_region')

  unless attributes[:'is_home_region'].nil?
    self.is_home_region = attributes[:'is_home_region']
  end

end

Instance Attribute Details

#is_home_region ⇒ BOOLEAN

[Required] Indicates if the region is the home region or not.

Returns:

  • (BOOLEAN) 


47
48
49
 
# File 'lib/oci/identity/models/region_subscription.rb', line 47

def is_home_region
  @is_home_region
end

#region_key ⇒ String

[Required] The region’s key.

Allowed values are:

  • ‘PHX`

  • ‘IAD`

  • ‘FRA`

  • ‘LHR`

Returns:

  • (String) 


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

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`

Returns:

  • (String) 


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

def region_name
  @region_name
end

#status ⇒ String

[Required] The region subscription status.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/identity/models/region_subscription.rb', line 43

def status
  @status
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



110
111
112
113
114
115
116
117
 
# File 'lib/oci/identity/models/region_subscription.rb', line 110

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      region_key == other_object.region_key &&
      region_name == other_object.region_name &&
      status == other_object.status &&
      is_home_region == other_object.is_home_region
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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/identity/models/region_subscription.rb', line 134

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


121
122
123
 
# File 'lib/oci/identity/models/region_subscription.rb', line 121

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/identity/models/region_subscription.rb', line 127

def hash
  [region_key, region_name, status, is_home_region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/identity/models/region_subscription.rb', line 159

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



153
154
155
 
# File 'lib/oci/identity/models/region_subscription.rb', line 153

def to_s
  to_hash.to_s
end