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

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

Overview

The configuration details for creating a load balancer.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

IP_MODE_ENUM = 
[
  IP_MODE_IPV4 = 'IPV4'.freeze,
  IP_MODE_IPV6 = 'IPV6'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLoadBalancerDetails

Initializes the object

Options Hash (attributes):



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 208

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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

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

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

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

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

  self.shape_details = attributes[:'shapeDetails'] if attributes[:'shapeDetails']

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

  self.shape_details = attributes[:'shape_details'] if attributes[:'shape_details']

  self.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil?
  self.is_private = false if is_private.nil? && !attributes.key?(:'isPrivate') # rubocop:disable Style/StringLiterals

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

  self.is_private = attributes[:'is_private'] unless attributes[:'is_private'].nil?
  self.is_private = false if is_private.nil? && !attributes.key?(:'isPrivate') && !attributes.key?(:'is_private') # rubocop:disable Style/StringLiterals

  self.ip_mode = attributes[:'ipMode'] if attributes[:'ipMode']
  self.ip_mode = "IPV4" if ip_mode.nil? && !attributes.key?(:'ipMode') # rubocop:disable Style/StringLiterals

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

  self.ip_mode = attributes[:'ip_mode'] if attributes[:'ip_mode']
  self.ip_mode = "IPV4" if ip_mode.nil? && !attributes.key?(:'ipMode') && !attributes.key?(:'ip_mode') # rubocop:disable Style/StringLiterals

  self.reserved_ips = attributes[:'reservedIps'] if attributes[:'reservedIps']

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

  self.reserved_ips = attributes[:'reserved_ips'] if attributes[:'reserved_ips']

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

  self.hostnames = attributes[:'hostnames'] if attributes[:'hostnames']

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

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

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

  self.network_security_group_ids = attributes[:'networkSecurityGroupIds'] if attributes[:'networkSecurityGroupIds']

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

  self.network_security_group_ids = attributes[:'network_security_group_ids'] if attributes[:'network_security_group_ids']

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

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

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

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

  self.ssl_cipher_suites = attributes[:'sslCipherSuites'] if attributes[:'sslCipherSuites']

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

  self.ssl_cipher_suites = attributes[:'ssl_cipher_suites'] if attributes[:'ssl_cipher_suites']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.rule_sets = attributes[:'ruleSets'] if attributes[:'ruleSets']

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

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

Instance Attribute Details

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



82
83
84
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 82

def backend_sets
  @backend_sets
end

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



105
106
107
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 105

def certificates
  @certificates
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer.



20
21
22
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 20

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`



127
128
129
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 127

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Example: example_load_balancer



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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`



119
120
121
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 119

def freeform_tags
  @freeform_tags
end

#hostnames ⇒ Hash<String, OCI::LoadBalancer::Models::HostnameDetails> 



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

def hostnames
  @hostnames
end

#ip_mode ⇒ String

Whether the load balancer has an IPv4 or IPv6 IP address.

If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.

If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.

Example: "ipMode":"IPV6"



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

def ip_mode
  @ip_mode
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.

If "false", the service assigns a public IP address to the load balancer.

A public load balancer is accessible from the internet, depending on your VCN’s [security list rules](docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).

Example: true



57
58
59
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 57

def is_private
  @is_private
end

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



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

def listeners
  @listeners
end

#network_security_group_ids ⇒ Array<String>

An array of NSG [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with this load balancer.

During the load balancer’s creation, the service adds the new load balancer to the specified NSGs.

The benefits of using NSGs with the load balancer include:

  • NSGs define network security rules to govern ingress and egress traffic for the load balancer.

  • The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access.

Example: ‘["ocid1.nsg.oc1.phx.unique_ID"]`



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

def network_security_group_ids
  @network_security_group_ids
end

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



111
112
113
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 111

def path_route_sets
  @path_route_sets
end

#reserved_ips ⇒ Array<OCI::LoadBalancer::Models::ReservedIP>

An array of reserved Ips.



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

def reserved_ips
  @reserved_ips
end

#rule_sets ⇒ Hash<String, OCI::LoadBalancer::Models::RuleSetDetails> 



130
131
132
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 130

def rule_sets
  @rule_sets
end

#shape_details ⇒ OCI::LoadBalancer::Models::ShapeDetails

The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.



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

def shape_details
  @shape_details
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



37
38
39
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 37

def shape_name
  @shape_name
end

#ssl_cipher_suites ⇒ Hash<String, OCI::LoadBalancer::Models::SSLCipherSuiteDetails> 



108
109
110
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 108

def ssl_cipher_suites
  @ssl_cipher_suites
end

#subnet_ids ⇒ Array<String>

[Required] An array of subnet [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).



102
103
104
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 102

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'shape_name': :'shapeName',
    'shape_details': :'shapeDetails',
    'is_private': :'isPrivate',
    'ip_mode': :'ipMode',
    'reserved_ips': :'reservedIps',
    'listeners': :'listeners',
    'hostnames': :'hostnames',
    'backend_sets': :'backendSets',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'subnet_ids': :'subnetIds',
    'certificates': :'certificates',
    'ssl_cipher_suites': :'sslCipherSuites',
    'path_route_sets': :'pathRouteSets',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'rule_sets': :'ruleSets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 159

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'shape_name': :'String',
    'shape_details': :'OCI::LoadBalancer::Models::ShapeDetails',
    'is_private': :'BOOLEAN',
    'ip_mode': :'String',
    'reserved_ips': :'Array<OCI::LoadBalancer::Models::ReservedIP>',
    'listeners': :'Hash<String, OCI::LoadBalancer::Models::ListenerDetails>',
    'hostnames': :'Hash<String, OCI::LoadBalancer::Models::HostnameDetails>',
    'backend_sets': :'Hash<String, OCI::LoadBalancer::Models::BackendSetDetails>',
    'network_security_group_ids': :'Array<String>',
    'subnet_ids': :'Array<String>',
    'certificates': :'Hash<String, OCI::LoadBalancer::Models::CertificateDetails>',
    'ssl_cipher_suites': :'Hash<String, OCI::LoadBalancer::Models::SSLCipherSuiteDetails>',
    'path_route_sets': :'Hash<String, OCI::LoadBalancer::Models::PathRouteSetDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'rule_sets': :'Hash<String, OCI::LoadBalancer::Models::RuleSetDetails>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 330

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    shape_name == other.shape_name &&
    shape_details == other.shape_details &&
    is_private == other.is_private &&
    ip_mode == other.ip_mode &&
    reserved_ips == other.reserved_ips &&
    listeners == other.listeners &&
    hostnames == other.hostnames &&
    backend_sets == other.backend_sets &&
    network_security_group_ids == other.network_security_group_ids &&
    subnet_ids == other.subnet_ids &&
    certificates == other.certificates &&
    ssl_cipher_suites == other.ssl_cipher_suites &&
    path_route_sets == other.path_route_sets &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    rule_sets == other.rule_sets
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 377

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

See Also:

  • `==` method


357
358
359
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 357

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



366
367
368
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 366

def hash
  [compartment_id, display_name, shape_name, shape_details, is_private, ip_mode, reserved_ips, listeners, hostnames, backend_sets, network_security_group_ids, subnet_ids, certificates, ssl_cipher_suites, path_route_sets, freeform_tags, defined_tags, rule_sets].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 410

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



404
405
406
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 404

def to_s
  to_hash.to_s
end