Class: OCI::NetworkLoadBalancer::Models::CreateNetworkLoadBalancerDetails

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

Overview

The properties that define a network load balancer. For more information, see Managing a network load balancer.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator. If you are an administrator who writes policies to give users access, then see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Constant Summary collapse

NLB_IP_VERSION_ENUM = 
[
  NLB_IP_VERSION_IPV4 = 'IPV4'.freeze,
  NLB_IP_VERSION_IPV4_AND_IPV6 = 'IPV4_AND_IPV6'.freeze,
  NLB_IP_VERSION_IPV6 = 'IPV6'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNetworkLoadBalancerDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 202

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.is_preserve_source_destination = attributes[:'isPreserveSourceDestination'] unless attributes[:'isPreserveSourceDestination'].nil?
  self.is_preserve_source_destination = false if is_preserve_source_destination.nil? && !attributes.key?(:'isPreserveSourceDestination') # rubocop:disable Style/StringLiterals

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

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

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

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

  self.is_symmetric_hash_enabled = attributes[:'is_symmetric_hash_enabled'] unless attributes[:'is_symmetric_hash_enabled'].nil?
  self.is_symmetric_hash_enabled = false if is_symmetric_hash_enabled.nil? && !attributes.key?(:'isSymmetricHashEnabled') && !attributes.key?(:'is_symmetric_hash_enabled') # 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.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil?
  self.is_private = true 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 = true if is_private.nil? && !attributes.key?(:'isPrivate') && !attributes.key?(:'is_private') # rubocop:disable Style/StringLiterals

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  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.nlb_ip_version = attributes[:'nlbIpVersion'] if attributes[:'nlbIpVersion']
  self.nlb_ip_version = "IPV4" if nlb_ip_version.nil? && !attributes.key?(:'nlbIpVersion') # rubocop:disable Style/StringLiterals

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

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

  self.subnet_ipv6_cidr = attributes[:'subnetIpv6Cidr'] if attributes[:'subnetIpv6Cidr']

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

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

  self.assigned_private_ipv4 = attributes[:'assignedPrivateIpv4'] if attributes[:'assignedPrivateIpv4']

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

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

  self.assigned_ipv6 = attributes[:'assignedIpv6'] if attributes[:'assignedIpv6']

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

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

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

  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.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']
end

Instance Attribute Details

#assigned_ipv6 ⇒ String

IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 110

def assigned_ipv6
  @assigned_ipv6
end

#assigned_private_ipv4 ⇒ String

Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 103

def assigned_private_ipv4
  @assigned_private_ipv4
end

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

Backend sets associated with the network load balancer.

Returns:



118
119
120
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 118

def backend_sets
  @backend_sets
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the network load balancer.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 29

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


130
131
132
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 130

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Network load balancer identifier, which can be renamed.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 33

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


124
125
126
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 124

def freeform_tags
  @freeform_tags
end

#is_preserve_source_destination ⇒ BOOLEAN

This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.

Returns:

  • (BOOLEAN) 


39
40
41
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 39

def is_preserve_source_destination
  @is_preserve_source_destination
end

#is_private ⇒ BOOLEAN

Whether the network load balancer has a virtual cloud network-local (private) IP address.

If "true", then the service assigns a private IP address to the network load balancer.

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

A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

Example: true

Returns:

  • (BOOLEAN) 


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

def is_private
  @is_private
end

#is_symmetric_hash_enabled ⇒ BOOLEAN

This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

Returns:

  • (BOOLEAN) 


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

def is_symmetric_hash_enabled
  @is_symmetric_hash_enabled
end

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

Listeners associated with the network load balancer.

Returns:



114
115
116
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 114

def listeners
  @listeners
end

#network_security_group_ids ⇒ Array<String>

An array of network security groups OCIDs associated with the network load balancer.

During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

The benefits of associating the network load balancer with network security groups include:

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

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

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

Returns:

  • (Array<String>) 


88
89
90
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 88

def network_security_group_ids
  @network_security_group_ids
end

#nlb_ip_version ⇒ String

IP version associated with the NLB.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 92

def nlb_ip_version
  @nlb_ip_version
end

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

An array of reserved Ips.

Returns:



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

def reserved_ips
  @reserved_ips
end

#subnet_id ⇒ String

[Required] The subnet in which the network load balancer is spawned OCIDs.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 71

def subnet_id
  @subnet_id
end

#subnet_ipv6_cidr ⇒ String

IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 96

def subnet_ipv6_cidr
  @subnet_ipv6_cidr
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
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'is_preserve_source_destination': :'isPreserveSourceDestination',
    'is_symmetric_hash_enabled': :'isSymmetricHashEnabled',
    'reserved_ips': :'reservedIps',
    'is_private': :'isPrivate',
    'subnet_id': :'subnetId',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'nlb_ip_version': :'nlbIpVersion',
    'subnet_ipv6_cidr': :'subnetIpv6Cidr',
    'assigned_private_ipv4': :'assignedPrivateIpv4',
    'assigned_ipv6': :'assignedIpv6',
    'listeners': :'listeners',
    'backend_sets': :'backendSets',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 157

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'is_preserve_source_destination': :'BOOLEAN',
    'is_symmetric_hash_enabled': :'BOOLEAN',
    'reserved_ips': :'Array<OCI::NetworkLoadBalancer::Models::ReservedIP>',
    'is_private': :'BOOLEAN',
    'subnet_id': :'String',
    'network_security_group_ids': :'Array<String>',
    'nlb_ip_version': :'String',
    'subnet_ipv6_cidr': :'String',
    'assigned_private_ipv4': :'String',
    'assigned_ipv6': :'String',
    'listeners': :'Hash<String, OCI::NetworkLoadBalancer::Models::ListenerDetails>',
    'backend_sets': :'Hash<String, OCI::NetworkLoadBalancer::Models::BackendSetDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 324

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    is_preserve_source_destination == other.is_preserve_source_destination &&
    is_symmetric_hash_enabled == other.is_symmetric_hash_enabled &&
    reserved_ips == other.reserved_ips &&
    is_private == other.is_private &&
    subnet_id == other.subnet_id &&
    network_security_group_ids == other.network_security_group_ids &&
    nlb_ip_version == other.nlb_ip_version &&
    subnet_ipv6_cidr == other.subnet_ipv6_cidr &&
    assigned_private_ipv4 == other.assigned_private_ipv4 &&
    assigned_ipv6 == other.assigned_ipv6 &&
    listeners == other.listeners &&
    backend_sets == other.backend_sets &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 369

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


349
350
351
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 349

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



358
359
360
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 358

def hash
  [compartment_id, display_name, is_preserve_source_destination, is_symmetric_hash_enabled, reserved_ips, is_private, subnet_id, network_security_group_ids, nlb_ip_version, subnet_ipv6_cidr, assigned_private_ipv4, assigned_ipv6, listeners, backend_sets, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 402

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



396
397
398
 
# File 'lib/oci/network_load_balancer/models/create_network_load_balancer_details.rb', line 396

def to_s
  to_hash.to_s
end