Class: OCI::LoadBalancer::Models::LoadBalancerHealthSummary

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

Overview

A health status summary for the specified load balancer.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :load_balancer_id (String) —

    The value to assign to the #load_balancer_id property

  • :status (String) —

    The value to assign to the #status property



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 48

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

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

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

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

end

Instance Attribute Details

#load_balancer_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer the health status is associated with.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 18

def load_balancer_id
  @load_balancer_id
end

#status ⇒ String

[Required] The overall health status of the load balancer.

  • OK: All backend sets associated with the load balancer return a status of ‘OK`.

  • WARNING: At least one of the backend sets associated with the load balancer returns a status of ‘WARNING`,

no backend sets return a status of ‘CRITICAL`, and the load balancer life cycle state is `ACTIVE`.

  • CRITICAL: One or more of the backend sets associated with the load balancer return a status of ‘CRITICAL`.

  • UNKNOWN: If any one of the following conditions is true:

    *  The load balancer life cycle state is not `ACTIVE`.

*  No backend sets are defined for the load balancer.

*  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
   sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.

*  The system could not retrieve metrics for any reason.

Returns:

  • (String) 


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

def status
  @status
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



82
83
84
85
86
87
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 82

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 104

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


91
92
93
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 91

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



97
98
99
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 97

def hash
  [load_balancer_id, status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 129

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



123
124
125
 
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 123

def to_s
  to_hash.to_s
end