Class: OCI::LoadBalancer::Models::BackendHealth

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

Overview

The health status of the specified backend server as reported by the primary and standby load balancers.

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 = {}) ⇒ BackendHealth

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 39

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[:'healthCheckResults']
    self.health_check_results = attributes[:'healthCheckResults']
  end

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

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

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

end

Instance Attribute Details

#health_check_results ⇒ Array<OCI::LoadBalancer::Models::HealthCheckResult>

[Required] A list of the most recent health check results returned for the specified backend server.

Returns:



19
20
21
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 19

def health_check_results
  @health_check_results
end

#status ⇒ String

[Required] The general health status of the specified backend server as reported by the primary and standby load balancers.

  • OK: Both health checks returned ‘OK`.

  • WARNING: One health check returned ‘OK` and one did not.

  • CRITICAL: Neither health check returned ‘OK`.

  • UNKNOWN: One or both health checks returned ‘UNKNOWN`, or the system was unable to retrieve metrics at this time.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 32

def status
  @status
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



73
74
75
76
77
78
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 73

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 95

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


82
83
84
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 82

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



88
89
90
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 88

def hash
  [health_check_results, status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 120

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



114
115
116
 
# File 'lib/oci/load_balancer/models/backend_health.rb', line 114

def to_s
  to_hash.to_s
end