Class: OCI::LoadBalancer::Models::BackendSetHealth

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

Overview

The health status details for a backend set.

This object does not explicitly enumerate backend servers with a status of ‘OK`. However, they are included in the `totalBackendCount` sum.

Constant Summary collapse

STATUS_ENUM =

rubocop:disable Metrics/LineLength

[
  STATUS_OK = 'OK'.freeze,
  STATUS_WARNING = 'WARNING'.freeze,
  STATUS_CRITICAL = 'CRITICAL'.freeze,
  STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackendSetHealth

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
133
134
135
136
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 105

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

  self.warning_state_backend_names = attributes[:'warningStateBackendNames'] if attributes[:'warningStateBackendNames']

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

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

  self.critical_state_backend_names = attributes[:'criticalStateBackendNames'] if attributes[:'criticalStateBackendNames']

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

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

  self.unknown_state_backend_names = attributes[:'unknownStateBackendNames'] if attributes[:'unknownStateBackendNames']

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

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

  self.total_backend_count = attributes[:'totalBackendCount'] if attributes[:'totalBackendCount']

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

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

Instance Attribute Details

#critical_state_backend_names ⇒ Array<String>

[Required] A list of backend servers that are currently in the ‘CRITICAL` health state. The list identifies each backend server by IP address and port.

Example: ‘10.0.0.4:8080`

Returns:

  • (Array<String>) 


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

def critical_state_backend_names
  @critical_state_backend_names
end

#status ⇒ String

[Required] Overall health status of the backend set.

  • OK: All backend servers in the backend set return a status of ‘OK`.

  • WARNING: Half or more of the backend set’s backend servers return a status of ‘OK` and at least one backend

server returns a status of ‘WARNING`, `CRITICAL`, or `UNKNOWN`.

  • CRITICAL: Fewer than half of the backend set’s backend servers return a status of ‘OK`.

  • UNKNOWN: More than half of the backend set’s backend servers return a status of ‘UNKNOWN`, the system was

unable to retrieve metrics, or the backend set does not have a listener attached.

Returns:

  • (String) 


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

def status
  @status
end

#total_backend_count ⇒ Integer

[Required] The total number of backend servers in this backend set.

Example: ‘7`

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 66

def total_backend_count
  @total_backend_count
end

#unknown_state_backend_names ⇒ Array<String>

[Required] A list of backend servers that are currently in the ‘UNKNOWN` health state. The list identifies each backend server by IP address and port.

Example: ‘10.0.0.5:8080`

Returns:

  • (Array<String>) 


59
60
61
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 59

def unknown_state_backend_names
  @unknown_state_backend_names
end

#warning_state_backend_names ⇒ Array<String>

[Required] A list of backend servers that are currently in the ‘WARNING` health state. The list identifies each backend server by IP address and port.

Example: ‘10.0.0.3:8080`

Returns:

  • (Array<String>) 


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

def warning_state_backend_names
  @warning_state_backend_names
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'warning_state_backend_names': :'warningStateBackendNames',
    'critical_state_backend_names': :'criticalStateBackendNames',
    'unknown_state_backend_names': :'unknownStateBackendNames',
    'total_backend_count': :'totalBackendCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'warning_state_backend_names': :'Array<String>',
    'critical_state_backend_names': :'Array<String>',
    'unknown_state_backend_names': :'Array<String>',
    'total_backend_count': :'Integer'
    # 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



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 160

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

  self.class == other.class &&
    status == other.status &&
    warning_state_backend_names == other.warning_state_backend_names &&
    critical_state_backend_names == other.critical_state_backend_names &&
    unknown_state_backend_names == other.unknown_state_backend_names &&
    total_backend_count == other.total_backend_count
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 194

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


174
175
176
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 183

def hash
  [status, warning_state_backend_names, critical_state_backend_names, unknown_state_backend_names, total_backend_count].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 227

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



221
222
223
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 221

def to_s
  to_hash.to_s
end