Class: OCI::NetworkLoadBalancer::Models::UpdateNetworkLoadBalancerDetails

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

Overview

Configuration details to update a network load balancer.

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

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 = {}) ⇒ UpdateNetworkLoadBalancerDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :is_preserve_source_destination (BOOLEAN) —

    The value to assign to the #is_preserve_source_destination property

  • :is_symmetric_hash_enabled (BOOLEAN) —

    The value to assign to the #is_symmetric_hash_enabled property

  • :nlb_ip_version (String) —

    The value to assign to the #nlb_ip_version property

  • :subnet_ipv6_cidr (String) —

    The value to assign to the #subnet_ipv6_cidr property

  • :assigned_ipv6 (String) —

    The value to assign to the #assigned_ipv6 property

  • :reserved_ipv6_id (String) —

    The value to assign to the #reserved_ipv6_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property



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

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.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.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_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.reserved_ipv6_id = attributes[:'reservedIpv6Id'] if attributes[:'reservedIpv6Id']

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

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

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

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

  self.security_attributes = attributes[:'security_attributes'] if attributes[:'security_attributes']
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) 


53
54
55
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 53

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

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-friendly display name for the network load balancer, which does not have to be unique and can be changed. Avoid entering confidential information.

Example: example_network_load_balancer

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 26

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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


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

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) 


32
33
34
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 32

def is_preserve_source_destination
  @is_preserve_source_destination
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) 


38
39
40
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 38

def is_symmetric_hash_enabled
  @is_symmetric_hash_enabled
end

#nlb_ip_version ⇒ String

IP version associated with the NLB.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 42

def nlb_ip_version
  @nlb_ip_version
end

#reserved_ipv6_id ⇒ String

The reservedIpv6Id field is used to specify the OCID of a reserved IPv6 address to be used only when updating NLB from single-stack IPv4 to dual-stack. This field should not be used for any other scenario

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 59

def reserved_ipv6_id
  @reserved_ipv6_id
end

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

ZPR 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.

Example: {\"oracle-zpr\": {\"td\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


83
84
85
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 83

def security_attributes
  @security_attributes
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) 


46
47
48
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 46

def subnet_ipv6_cidr
  @subnet_ipv6_cidr
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'is_preserve_source_destination': :'isPreserveSourceDestination',
    'is_symmetric_hash_enabled': :'isSymmetricHashEnabled',
    'nlb_ip_version': :'nlbIpVersion',
    'subnet_ipv6_cidr': :'subnetIpv6Cidr',
    'assigned_ipv6': :'assignedIpv6',
    'reserved_ipv6_id': :'reservedIpv6Id',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'is_preserve_source_destination': :'BOOLEAN',
    'is_symmetric_hash_enabled': :'BOOLEAN',
    'nlb_ip_version': :'String',
    'subnet_ipv6_cidr': :'String',
    'assigned_ipv6': :'String',
    'reserved_ipv6_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 225

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

  self.class == other.class &&
    display_name == other.display_name &&
    is_preserve_source_destination == other.is_preserve_source_destination &&
    is_symmetric_hash_enabled == other.is_symmetric_hash_enabled &&
    nlb_ip_version == other.nlb_ip_version &&
    subnet_ipv6_cidr == other.subnet_ipv6_cidr &&
    assigned_ipv6 == other.assigned_ipv6 &&
    reserved_ipv6_id == other.reserved_ipv6_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 264

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


244
245
246
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 253

def hash
  [display_name, is_preserve_source_destination, is_symmetric_hash_enabled, nlb_ip_version, subnet_ipv6_cidr, assigned_ipv6, reserved_ipv6_id, freeform_tags, defined_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 297

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



291
292
293
 
# File 'lib/oci/network_load_balancer/models/update_network_load_balancer_details.rb', line 291

def to_s
  to_hash.to_s
end