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 [Managing Backend Sets](docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm).

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):

  • :name (String) —

    The value to assign to the #name property

  • :policy (String) —

    The value to assign to the #policy property

  • :is_preserve_source (BOOLEAN) —

    The value to assign to the #is_preserve_source property

  • :ip_version (String) —

    The value to assign to the #ip_version property

  • :backends (Array<OCI::NetworkLoadBalancer::Models::Backend>) —

    The value to assign to the #backends property

  • :health_checker (OCI::NetworkLoadBalancer::Models::HealthChecker) —

    The value to assign to the #health_checker property



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

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

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

[Required] An array of backends.

Returns:

  • (Array<OCI::NetworkLoadBalancer::Models::Backend>) 


60
61
62
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 60

def backends
  @backends
end

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

This attribute is required.

Returns:

  • (OCI::NetworkLoadBalancer::Models::HealthChecker) 


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

def health_checker
  @health_checker
end

#ip_version ⇒ String

IP version associated with the backend set.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 55

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


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

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) 


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

def name
  @name
end

#policy ⇒ String

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

Example: FIVE_TUPLE

Returns:

  • (String) 


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

def policy
  @policy
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'policy': :'policy',
    'is_preserve_source': :'isPreserveSource',
    'ip_version': :'ipVersion',
    '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
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 81

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



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 175

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

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 210

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


190
191
192
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 199

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



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

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



237
238
239
 
# File 'lib/oci/network_load_balancer/models/backend_set_summary.rb', line 237

def to_s
  to_hash.to_s
end