Class: OCI::NetworkLoadBalancer::Models::BackendHealth

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

Overview

The health status of the specified backend server.

Constant Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 68

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

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

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

Instance Attribute Details

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

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

Returns:



38
39
40
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 38

def health_check_results
  @health_check_results
end

#status ⇒ String

[Required] The general health status of the specified backend server.

  • OK: All health check probes return OK

  • WARNING: At least one of the health check probes does not return OK

  • CRITICAL: None of the health check probes return OK. *

  • UNKNOWN: One of the health checks probes return UNKNOWN,

  • or the system is unable to retrieve metrics at this time.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 33

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'health_check_results': :'healthCheckResults'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'health_check_results': :'Array<OCI::NetworkLoadBalancer::Models::HealthCheckResult>'
    # 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



103
104
105
106
107
108
109
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 103

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

  self.class == other.class &&
    status == other.status &&
    health_check_results == other.health_check_results
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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 134

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 123

def hash
  [status, health_check_results].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 167

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



161
162
163
 
# File 'lib/oci/network_load_balancer/models/backend_health.rb', line 161

def to_s
  to_hash.to_s
end