Class: OCI::LoadBalancer::Models::LoadBalancerHealth

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

Overview

The health status details for the specified load balancer.

This object does not explicitly enumerate backend sets with a status of ‘OK`. However, they are included in the `totalBackendSetCount` 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 = {}) ⇒ LoadBalancerHealth

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
124
125
126
127
128
129
130
131
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 81

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

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

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

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

  if attributes[:'totalBackendSetCount']
    self.total_backend_set_count = attributes[:'totalBackendSetCount']
  end

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

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

  if attributes[:'unknownStateBackendSetNames']
    self.unknown_state_backend_set_names = attributes[:'unknownStateBackendSetNames']
  end

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

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

  if attributes[:'warningStateBackendSetNames']
    self.warning_state_backend_set_names = attributes[:'warningStateBackendSetNames']
  end

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

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

end

Instance Attribute Details

#critical_state_backend_set_names ⇒ Array<String>

[Required] A list of backend sets that are currently in the ‘CRITICAL` health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: ‘My_backend_set`

Returns:

  • (Array<String>) 


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

def critical_state_backend_set_names
  @critical_state_backend_set_names
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) 


48
49
50
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 48

def status
  @status
end

#total_backend_set_count ⇒ Integer

[Required] The total number of backend sets associated with this load balancer.

Example: ‘4`

Returns:

  • (Integer) 


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

def total_backend_set_count
  @total_backend_set_count
end

#unknown_state_backend_set_names ⇒ Array<String>

[Required] A list of backend sets that are currently in the ‘UNKNOWN` health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: ‘Backend_set2`

Returns:

  • (Array<String>) 


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

def unknown_state_backend_set_names
  @unknown_state_backend_set_names
end

#warning_state_backend_set_names ⇒ Array<String>

[Required] A list of backend sets that are currently in the ‘WARNING` health state. The list identifies each backend set by the friendly name you assigned when you created it.

Example: ‘Backend_set3`

Returns:

  • (Array<String>) 


71
72
73
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 71

def warning_state_backend_set_names
  @warning_state_backend_set_names
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 145

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      critical_state_backend_set_names == other_object.critical_state_backend_set_names &&
      status == other_object.status &&
      total_backend_set_count == other_object.total_backend_set_count &&
      unknown_state_backend_set_names == other_object.unknown_state_backend_set_names &&
      warning_state_backend_set_names == other_object.warning_state_backend_set_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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 170

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


157
158
159
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 157

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 163

def hash
  [critical_state_backend_set_names, status, total_backend_set_count, unknown_state_backend_set_names, warning_state_backend_set_names].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 195

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



189
190
191
 
# File 'lib/oci/load_balancer/models/load_balancer_health.rb', line 189

def to_s
  to_hash.to_s
end