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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 75

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

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

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

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

Instance Attribute Details

#load_balancer_idString

[Required] The OCID of the load balancer the health status is associated with.

Returns:

  • (String)


22
23
24
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 22

def load_balancer_id
  @load_balancer_id
end

#statusString

[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)


45
46
47
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 45

def status
  @status
end

Class Method Details

.attribute_mapObject

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



48
49
50
51
52
53
54
55
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 48

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

.swagger_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'load_balancer_id': :'String',
    'status': :'String'
    # 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



110
111
112
113
114
115
116
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 110

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

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 141

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


121
122
123
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 121

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



130
131
132
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 130

def hash
  [load_balancer_id, status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 174

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



168
169
170
# File 'lib/oci/load_balancer/models/load_balancer_health_summary.rb', line 168

def to_s
  to_hash.to_s
end