Class: OCI::NetworkLoadBalancer::Models::BackendSetDetails
- Inherits:
-
Object
- Object
- OCI::NetworkLoadBalancer::Models::BackendSetDetails
- 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
-
#backends ⇒ Array<OCI::NetworkLoadBalancer::Models::Backend>
An array of backends.
-
#health_checker ⇒ OCI::NetworkLoadBalancer::Models::HealthChecker
This attribute is required.
-
#ip_version ⇒ String
IP version associated with the backend set.
-
#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.
-
#is_instant_failover_enabled ⇒ BOOLEAN
If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
-
#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.
-
#policy ⇒ String
The network load balancer policy for the backend set.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BackendSetDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ BackendSetDetails
Initializes the object
108 109 110 111 112 113 114 115 116 117 118 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 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 108 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.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.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.
59 60 61 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 59 def backends @backends end |
#health_checker ⇒ OCI::NetworkLoadBalancer::Models::HealthChecker
This attribute is required.
63 64 65 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 63 def health_checker @health_checker end |
#ip_version ⇒ String
IP version associated with the backend set.
36 37 38 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 36 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.
49 50 51 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 49 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.
54 55 56 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 54 def is_instant_failover_enabled @is_instant_failover_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.
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
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.
66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'policy': :'policy', 'ip_version': :'ipVersion', 'is_preserve_source': :'isPreserveSource', 'is_fail_open': :'isFailOpen', 'is_instant_failover_enabled': :'isInstantFailoverEnabled', 'backends': :'backends', 'health_checker': :'healthChecker' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 81 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'policy': :'String', 'ip_version': :'String', 'is_preserve_source': :'BOOLEAN', 'is_fail_open': :'BOOLEAN', 'is_instant_failover_enabled': :'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.
179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 179 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 && is_fail_open == other.is_fail_open && is_instant_failover_enabled == other.is_instant_failover_enabled && backends == other.backends && health_checker == other.health_checker end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 215 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
195 196 197 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 195 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
204 205 206 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 204 def hash [policy, ip_version, is_preserve_source, is_fail_open, is_instant_failover_enabled, backends, health_checker].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
248 249 250 251 252 253 254 255 256 257 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 248 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
242 243 244 |
# File 'lib/oci/network_load_balancer/models/backend_set_details.rb', line 242 def to_s to_hash.to_s end |