Class: OCI::LoadBalancer::Models::LoadBalancer

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

Overview

The properties that define a load balancer. For more information, see [Managing a Load Balancer](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingloadbalancer.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).

For information about endpoints and signing API requests, see [About the API](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoadBalancer

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 116

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

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

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

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

  if attributes[:'ipAddresses']
    self.ip_addresses = attributes[:'ipAddresses']
  end

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

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

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

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

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

  if attributes[:'pathRouteSets']
    self.path_route_sets = attributes[:'pathRouteSets']
  end

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

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

  if attributes[:'shapeName']
    self.shape_name = attributes[:'shapeName']
  end

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

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

  if attributes[:'subnetIds']
    self.subnet_ids = attributes[:'subnetIds']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#backend_sets ⇒ Hash<String, OCI::LoadBalancer::Models::BackendSet>

Returns:



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

def backend_sets
  @backend_sets
end

#certificates ⇒ Hash<String, OCI::LoadBalancer::Models::Certificate>

Returns:



30
31
32
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 30

def certificates
  @certificates
end

#compartment_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 34

def compartment_id
  @compartment_id
end

#display_name ⇒ String

[Required] A user-friendly name. It does not have to be unique, and it is changeable.

Example: ‘My load balancer`

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 41

def display_name
  @display_name
end

#id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 45

def id
  @id
end

#ip_addresses ⇒ Array<OCI::LoadBalancer::Models::IpAddress>

An array of IP addresses.

Returns:



50
51
52
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 50

def ip_addresses
  @ip_addresses
end

#is_private ⇒ BOOLEAN

Whether the load balancer has a VCN-local (private) IP address.

If "true", the service assigns a private IP address to the load balancer. The load balancer requires only one subnet to host both the primary and secondary load balancers. The private IP address is local to the subnet. The load balancer is accessible only from within the VCN that contains the associated subnet, or as further restricted by your security list rules. The load balancer can route traffic to any backend server that is reachable from the VCN.

For a private load balancer, both the primary and secondary load balancer hosts are within the same Availability Domain.

If "false", the service assigns a public IP address to the load balancer. A load balancer with a public IP address requires two subnets, each in a different Availability Domain. One subnet hosts the primary load balancer and the other hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN’s [security list rules](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm).

Returns:

  • (BOOLEAN) 


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

def is_private
  @is_private
end

#lifecycle_state ⇒ String

[Required] The current state of the load balancer.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 72

def lifecycle_state
  @lifecycle_state
end

#listeners ⇒ Hash<String, OCI::LoadBalancer::Models::Listener>

Returns:



75
76
77
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 75

def listeners
  @listeners
end

#path_route_sets ⇒ Hash<String, OCI::LoadBalancer::Models::PathRouteSet>

Returns:



78
79
80
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 78

def path_route_sets
  @path_route_sets
end

#shape_name ⇒ String

[Required] A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the list_shapes operation.

Example: ‘100Mbps`

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 87

def shape_name
  @shape_name
end

#subnet_ids ⇒ Array<String>

An array of subnet [OCIDs](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).

Returns:

  • (Array<String>) 


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

def subnet_ids
  @subnet_ids
end

#time_created ⇒ DateTime

[Required] The date and time the load balancer was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 98

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 248

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      backend_sets == other_object.backend_sets &&
      certificates == other_object.certificates &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      ip_addresses == other_object.ip_addresses &&
      is_private == other_object.is_private &&
      lifecycle_state == other_object.lifecycle_state &&
      listeners == other_object.listeners &&
      path_route_sets == other_object.path_route_sets &&
      shape_name == other_object.shape_name &&
      subnet_ids == other_object.subnet_ids &&
      time_created == other_object.time_created
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 281

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


268
269
270
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 268

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 274

def hash
  [backend_sets, certificates, compartment_id, display_name, id, ip_addresses, is_private, lifecycle_state, listeners, path_route_sets, shape_name, subnet_ids, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 306

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



300
301
302
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 300

def to_s
  to_hash.to_s
end