Class: OCI::NetworkLoadBalancer::Models::UpdateBackendSetDetails

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

Overview

The configuration details for updating a load balancer backend set. For more information about backend set configuration, see Backend Sets for Network Load Balancers.

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

Constant Summary collapse

IP_VERSION_ENUM = 
[
  IP_VERSION_IPV4 = 'IPV4'.freeze,
  IP_VERSION_IPV6 = 'IPV6'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBackendSetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

  self.is_preserve_source = attributes[:'isPreserveSource'] unless attributes[:'isPreserveSource'].nil?
  self.is_preserve_source = true if is_preserve_source.nil? && !attributes.key?(:'isPreserveSource') # rubocop:disable Style/StringLiterals

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

  self.is_preserve_source = attributes[:'is_preserve_source'] unless attributes[:'is_preserve_source'].nil?
  self.is_preserve_source = true if is_preserve_source.nil? && !attributes.key?(:'isPreserveSource') && !attributes.key?(:'is_preserve_source') # rubocop:disable Style/StringLiterals

  self.is_fail_open = attributes[:'isFailOpen'] unless attributes[:'isFailOpen'].nil?

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

  self.is_fail_open = attributes[:'is_fail_open'] unless attributes[:'is_fail_open'].nil?

  self.is_instant_failover_enabled = attributes[:'isInstantFailoverEnabled'] unless attributes[:'isInstantFailoverEnabled'].nil?

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

  self.is_instant_failover_enabled = attributes[:'is_instant_failover_enabled'] unless attributes[:'is_instant_failover_enabled'].nil?

  self.is_instant_failover_tcp_reset_enabled = attributes[:'isInstantFailoverTcpResetEnabled'] unless attributes[:'isInstantFailoverTcpResetEnabled'].nil?

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

  self.is_instant_failover_tcp_reset_enabled = attributes[:'is_instant_failover_tcp_reset_enabled'] unless attributes[:'is_instant_failover_tcp_reset_enabled'].nil?

  self.are_operationally_active_backends_preferred = attributes[:'areOperationallyActiveBackendsPreferred'] unless attributes[:'areOperationallyActiveBackendsPreferred'].nil?

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

  self.are_operationally_active_backends_preferred = attributes[:'are_operationally_active_backends_preferred'] unless attributes[:'are_operationally_active_backends_preferred'].nil?

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

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

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

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

  self.health_checker = attributes[:'healthChecker'] if attributes[:'healthChecker']

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

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

Instance Attribute Details

#are_operationally_active_backends_preferred ⇒ BOOLEAN

If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 57

def are_operationally_active_backends_preferred
  @are_operationally_active_backends_preferred
end

#backends ⇒ Array<OCI::NetworkLoadBalancer::Models::BackendDetails>

An array of backends associated with the backend set.

Returns:



65
66
67
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 65

def backends
  @backends
end

#health_checker ⇒ OCI::NetworkLoadBalancer::Models::HealthCheckerDetails

Returns:



68
69
70
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 68

def health_checker
  @health_checker
end

#ip_version ⇒ String

The IP version associated with the backend set.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 61

def ip_version
  @ip_version
end

#is_fail_open ⇒ BOOLEAN

If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 40

def is_fail_open
  @is_fail_open
end

#is_instant_failover_enabled ⇒ BOOLEAN

If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.

Returns:

  • (BOOLEAN) 


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

def is_instant_failover_enabled
  @is_instant_failover_enabled
end

#is_instant_failover_tcp_reset_enabled ⇒ BOOLEAN

This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 51

def is_instant_failover_tcp_reset_enabled
  @is_instant_failover_tcp_reset_enabled
end

#is_preserve_source ⇒ BOOLEAN

If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

Returns:

  • (BOOLEAN) 


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

def is_preserve_source
  @is_preserve_source
end

#policy ⇒ String

The network load balancer policy for the backend set. To get a list of available policies, use the list_network_load_balancers_policies operation.

Example: FIVE_TUPLE

Returns:

  • (String) 


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

def policy
  @policy
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'policy',
    'is_preserve_source': :'isPreserveSource',
    'is_fail_open': :'isFailOpen',
    'is_instant_failover_enabled': :'isInstantFailoverEnabled',
    'is_instant_failover_tcp_reset_enabled': :'isInstantFailoverTcpResetEnabled',
    'are_operationally_active_backends_preferred': :'areOperationallyActiveBackendsPreferred',
    'ip_version': :'ipVersion',
    'backends': :'backends',
    'health_checker': :'healthChecker'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'String',
    'is_preserve_source': :'BOOLEAN',
    'is_fail_open': :'BOOLEAN',
    'is_instant_failover_enabled': :'BOOLEAN',
    'is_instant_failover_tcp_reset_enabled': :'BOOLEAN',
    'are_operationally_active_backends_preferred': :'BOOLEAN',
    'ip_version': :'String',
    'backends': :'Array<OCI::NetworkLoadBalancer::Models::BackendDetails>',
    'health_checker': :'OCI::NetworkLoadBalancer::Models::HealthCheckerDetails'
    # 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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 192

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

  self.class == other.class &&
    policy == other.policy &&
    is_preserve_source == other.is_preserve_source &&
    is_fail_open == other.is_fail_open &&
    is_instant_failover_enabled == other.is_instant_failover_enabled &&
    is_instant_failover_tcp_reset_enabled == other.is_instant_failover_tcp_reset_enabled &&
    are_operationally_active_backends_preferred == other.are_operationally_active_backends_preferred &&
    ip_version == other.ip_version &&
    backends == other.backends &&
    health_checker == other.health_checker
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 230

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


210
211
212
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 219

def hash
  [policy, is_preserve_source, is_fail_open, is_instant_failover_enabled, is_instant_failover_tcp_reset_enabled, are_operationally_active_backends_preferred, ip_version, backends, health_checker].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 263

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



257
258
259
 
# File 'lib/oci/network_load_balancer/models/update_backend_set_details.rb', line 257

def to_s
  to_hash.to_s
end