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 = 
[STATUS_OK = 'OK',
STATUS_WARNING = 'WARNING',
STATUS_CRITICAL = 'CRITICAL',
STATUS_UNKNOWN = 'UNKNOWN',
STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

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



73
74
75
76
77
78
79
80
81
82
83
84
85
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
116
117
118
119
120
121
122
123
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 73

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}

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

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

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

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

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

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

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

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

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

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

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

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

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

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: ‘1.1.1.1:80`

Returns:

  • (Array<String>) 


25
26
27
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 25

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) 


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

def status
  @status
end

#total_backend_count ⇒ Integer

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

Example: ‘5`

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 47

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: ‘1.1.1.5:80`

Returns:

  • (Array<String>) 


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

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: ‘1.1.1.7:42`

Returns:

  • (Array<String>) 


63
64
65
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 63

def warning_state_backend_names
  @warning_state_backend_names
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 137

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      critical_state_backend_names == other_object.critical_state_backend_names &&
      status == other_object.status &&
      total_backend_count == other_object.total_backend_count &&
      unknown_state_backend_names == other_object.unknown_state_backend_names &&
      warning_state_backend_names == other_object.warning_state_backend_names
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



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

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 149

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 155

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 187

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



181
182
183
 
# File 'lib/oci/load_balancer/models/backend_set_health.rb', line 181

def to_s
  to_hash.to_s
end