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

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



86
87
88
89
90
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
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 86

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

Instance Attribute Details

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

This attribute is required.

Returns:



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

def backends
  @backends
end

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

This attribute is required.

Returns:



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

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


22
23
24
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 22

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) 


30
31
32
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 30

def policy
  @policy
end

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

Returns:



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

def session_persistence_configuration
  @session_persistence_configuration
end

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

Returns:



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

def ssl_configuration
  @ssl_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 47

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

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 61

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



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 124

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 159

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


139
140
141
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 148

def hash
  [name, policy, backends, health_checker, ssl_configuration, 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



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 192

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



186
187
188
 
# File 'lib/oci/load_balancer/models/backend_set.rb', line 186

def to_s
  to_hash.to_s
end