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



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
124
125
126
127
128
129
130
131
132
# File 'lib/oci/load_balancer/models/backend_set.rb', line 97

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

#backendsArray<OCI::LoadBalancer::Models::Backend>

This attribute is required.



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

def backends
  @backends
end

#health_checkerOCI::LoadBalancer::Models::HealthChecker

This attribute is required.



43
44
45
# File 'lib/oci/load_balancer/models/backend_set.rb', line 43

def health_checker
  @health_checker
end


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

def lb_cookie_session_persistence_configuration
  @lb_cookie_session_persistence_configuration
end

#nameString

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


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

def name
  @name
end

#policyString

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


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

def policy
  @policy
end

#session_persistence_configurationOCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails



49
50
51
# File 'lib/oci/load_balancer/models/backend_set.rb', line 49

def session_persistence_configuration
  @session_persistence_configuration
end

#ssl_configurationOCI::LoadBalancer::Models::SSLConfiguration



46
47
48
# File 'lib/oci/load_balancer/models/backend_set.rb', line 46

def ssl_configuration
  @ssl_configuration
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/load_balancer/models/backend_set.rb', line 55

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

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/load_balancer/models/backend_set.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'policy': :'String',
    'backends': :'Array<OCI::LoadBalancer::Models::Backend>',
    '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



141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/load_balancer/models/backend_set.rb', line 141

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

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/oci/load_balancer/models/backend_set.rb', line 177

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


157
158
159
# File 'lib/oci/load_balancer/models/backend_set.rb', line 157

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



166
167
168
# File 'lib/oci/load_balancer/models/backend_set.rb', line 166

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/load_balancer/models/backend_set.rb', line 210

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



204
205
206
# File 'lib/oci/load_balancer/models/backend_set.rb', line 204

def to_s
  to_hash.to_s
end