Class: OCI::NetworkLoadBalancer::Models::BackendSetDetails

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

Overview

The configuration of a network load balancer backend set. For more information about backend set configuration, see Managing Backend Sets.

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
].freeze
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 = {}) ⇒ BackendSetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 91

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

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

An array of backends.

Returns:



48
49
50
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 48

def backends
  @backends
end

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

This attribute is required.

Returns:



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

def health_checker
  @health_checker
end

#ip_version ⇒ String

IP version associated with the backend set.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 36

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


43
44
45
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 43

def is_preserve_source
  @is_preserve_source
end

#policy ⇒ String

The network load balancer policy for the backend set.

Example: FIVE_TUPLE

Returns:

  • (String) 


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

def policy
  @policy
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'policy',
    'ip_version': :'ipVersion',
    'is_preserve_source': :'isPreserveSource',
    'backends': :'backends',
    'health_checker': :'healthChecker'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'String',
    'ip_version': :'String',
    'is_preserve_source': :'BOOLEAN',
    '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



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 148

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

  self.class == other.class &&
    policy == other.policy &&
    ip_version == other.ip_version &&
    is_preserve_source == other.is_preserve_source &&
    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



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_details.rb', line 182

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


162
163
164
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 171

def hash
  [policy, ip_version, is_preserve_source, 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



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 215

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



209
210
211
 
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 209

def to_s
  to_hash.to_s
end