Class: OCI::NetworkLoadBalancer::Models::BackendSetSummary

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

Overview

The configuration of a network 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

POLICY_ENUM = 
[
  POLICY_TWO_TUPLE = 'TWO_TUPLE'.freeze,
  POLICY_THREE_TUPLE = 'THREE_TUPLE'.freeze,
  POLICY_FIVE_TUPLE = 'FIVE_TUPLE'.freeze,
  POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IP_VERSION_ENUM = 
[
  IP_VERSION_IPV4 = 'IPV4'.freeze,
  IP_VERSION_IPV6 = 'IPV6'.freeze,
  IP_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackendSetSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

  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_fail_open = false if is_fail_open.nil? && !attributes.key?(:'isFailOpen') && !attributes.key?(:'is_fail_open') # rubocop:disable Style/StringLiterals

  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?
  self.is_instant_failover_tcp_reset_enabled = true if is_instant_failover_tcp_reset_enabled.nil? && !attributes.key?(:'isInstantFailoverTcpResetEnabled') # rubocop:disable Style/StringLiterals

  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.is_instant_failover_tcp_reset_enabled = true if is_instant_failover_tcp_reset_enabled.nil? && !attributes.key?(:'isInstantFailoverTcpResetEnabled') && !attributes.key?(:'is_instant_failover_tcp_reset_enabled') # rubocop:disable Style/StringLiterals

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

  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.are_operationally_active_backends_preferred = false if are_operationally_active_backends_preferred.nil? && !attributes.key?(:'areOperationallyActiveBackendsPreferred') && !attributes.key?(:'are_operationally_active_backends_preferred') # rubocop:disable Style/StringLiterals

  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. The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.

Returns:

  • (BOOLEAN) 


73
74
75
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 73

def are_operationally_active_backends_preferred
  @are_operationally_active_backends_preferred
end

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

[Required] An array of backends.

Returns:



82
83
84
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 82

def backends
  @backends
end

#health_checker ⇒ OCI::NetworkLoadBalancer::Models::HealthChecker

This attribute is required.

Returns:



86
87
88
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 86

def health_checker
  @health_checker
end

#ip_version ⇒ String

IP version associated with the backend set.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 77

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) 


58
59
60
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 58

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) 


63
64
65
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 63

def is_instant_failover_enabled
  @is_instant_failover_enabled
end

#is_instant_failover_tcp_reset_enabled ⇒ BOOLEAN

If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend. This only applies when using the instant failover. By default, TCP RST is enabled.

Returns:

  • (BOOLEAN) 


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

def is_instant_failover_tcp_reset_enabled
  @is_instant_failover_tcp_reset_enabled
end

#is_preserve_source ⇒ BOOLEAN

If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers. Backend servers see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, this parameter cannot be disabled. The value is true by default.

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 52

def is_preserve_source
  @is_preserve_source
end

#name ⇒ String

[Required] A user-friendly name for the backend set that must be unique and cannot be changed.

Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

Example: example_backend_set

Returns:

  • (String) 


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

def name
  @name
end

#policy ⇒ String

[Required] The network load balancer policy for the backend set.

Example: FIVE_TUPLE

Returns:

  • (String) 


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

def policy
  @policy
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    '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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 107

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    '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::Backend>',
    'health_checker': :'OCI::NetworkLoadBalancer::Models::HealthChecker'
    # 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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 239

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

  self.class == other.class &&
    name == other.name &&
    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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 278

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


258
259
260
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 258

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 267

def hash
  [name, 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



311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 311

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



305
306
307
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 305

def to_s
  to_hash.to_s
end