Class: OCI::LoadBalancer::Models::BackendSet

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/models/backend_set.rb

Overview

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

Note: The sessionPersistenceConfiguration (application cookie stickiness) and lbCookieSessionPersistenceConfiguration (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackendSet

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 112

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

  self.backend_max_connections = attributes[:'backendMaxConnections'] if attributes[:'backendMaxConnections']

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

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

  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']

  self.ssl_configuration = attributes[:'sslConfiguration'] if attributes[:'sslConfiguration']

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

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

  self.session_persistence_configuration = attributes[:'sessionPersistenceConfiguration'] if attributes[:'sessionPersistenceConfiguration']

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

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

  self.lb_cookie_session_persistence_configuration = attributes[:'lbCookieSessionPersistenceConfiguration'] if attributes[:'lbCookieSessionPersistenceConfiguration']

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

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

Instance Attribute Details

#backend_max_connections ⇒ Integer

The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited.

Example: 300

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 51

def backend_max_connections
  @backend_max_connections
end

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

This attribute is required.

Returns:



40
41
42
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 40

def backends
  @backends
end

#health_checker ⇒ OCI::LoadBalancer::Models::HealthChecker

This attribute is required.

Returns:



55
56
57
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 55

def health_checker
  @health_checker
end

#lb_cookie_session_persistence_configuration ⇒ OCI::LoadBalancer::Models::LBCookieSessionPersistenceConfigurationDetails

Returns:



64
65
66
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 64

def lb_cookie_session_persistence_configuration
  @lb_cookie_session_persistence_configuration
end

#name ⇒ String

[Required] A friendly name for the backend set. It must be unique and it 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) 


28
29
30
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 28

def name
  @name
end

#policy ⇒ String

[Required] The load balancer policy for the backend set. To get a list of available policies, use the list_policies operation.

Example: LEAST_CONNECTIONS

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 36

def policy
  @policy
end

#session_persistence_configuration ⇒ OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails

Returns:



61
62
63
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 61

def session_persistence_configuration
  @session_persistence_configuration
end

#ssl_configuration ⇒ OCI::LoadBalancer::Models::SSLConfiguration

Returns:



58
59
60
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 58

def ssl_configuration
  @ssl_configuration
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
79
80
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'policy': :'policy',
    'backends': :'backends',
    'backend_max_connections': :'backendMaxConnections',
    'health_checker': :'healthChecker',
    'ssl_configuration': :'sslConfiguration',
    'session_persistence_configuration': :'sessionPersistenceConfiguration',
    'lb_cookie_session_persistence_configuration': :'lbCookieSessionPersistenceConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'policy': :'String',
    'backends': :'Array<OCI::LoadBalancer::Models::Backend>',
    'backend_max_connections': :'Integer',
    'health_checker': :'OCI::LoadBalancer::Models::HealthChecker',
    'ssl_configuration': :'OCI::LoadBalancer::Models::SSLConfiguration',
    'session_persistence_configuration': :'OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails',
    'lb_cookie_session_persistence_configuration': :'OCI::LoadBalancer::Models::LBCookieSessionPersistenceConfigurationDetails'
    # 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



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 162

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

  self.class == other.class &&
    name == other.name &&
    policy == other.policy &&
    backends == other.backends &&
    backend_max_connections == other.backend_max_connections &&
    health_checker == other.health_checker &&
    ssl_configuration == other.ssl_configuration &&
    session_persistence_configuration == other.session_persistence_configuration &&
    lb_cookie_session_persistence_configuration == other.lb_cookie_session_persistence_configuration
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 199

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


179
180
181
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 188

def hash
  [name, policy, backends, backend_max_connections, health_checker, ssl_configuration, session_persistence_configuration, lb_cookie_session_persistence_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 232

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



226
227
228
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 226

def to_s
  to_hash.to_s
end