class OCI::NetworkLoadBalancer::Models::BackendSetHealth
The health status details for a backend set.
This object does not explicitly enumerate backend servers with a status of `OK`. However, the backend sets are included in the `totalBackendCount` sum.
Constants
- STATUS_ENUM
Attributes
[Required] A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by IP address and port.
Example: `10.0.0.4:8080`
@return [Array<String>]
[Required] Overall health status of the backend set.
-
OK: All backend servers in the backend set return a status of `OK`.
-
WARNING: Half or more of the backend servers in a backend set return a status of `OK` and at least one backend
server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.
-
CRITICAL: Fewer than half of the backend servers in a backend set return a status of `OK`.
-
UNKNOWN: If no probes have yet been sent to the backends, or the system is
unable to retrieve metrics from the backends.
@return [String]
[Required] The total number of backend servers in this backend set.
Example: `7`
@return [Integer]
[Required] A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by IP address and port.
Example: `10.0.0.5:8080`
@return [Array<String>]
[Required] A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by IP address or OCID and port.
Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var><unique_ID></var>:8080`
@return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 70 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'status': :'status', 'warning_state_backend_names': :'warningStateBackendNames', 'critical_state_backend_names': :'criticalStateBackendNames', 'unknown_state_backend_names': :'unknownStateBackendNames', 'total_backend_count': :'totalBackendCount' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :status The value to assign to the {#status} property @option attributes [Array<String>] :warning_state_backend_names The value to assign to the {#warning_state_backend_names} property @option attributes [Array<String>] :critical_state_backend_names The value to assign to the {#critical_state_backend_names} property @option attributes [Array<String>] :unknown_state_backend_names The value to assign to the {#unknown_state_backend_names} property @option attributes [Integer] :total_backend_count The value to assign to the {#total_backend_count} property
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 106 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.warning_state_backend_names = attributes[:'warningStateBackendNames'] if attributes[:'warningStateBackendNames'] raise 'You cannot provide both :warningStateBackendNames and :warning_state_backend_names' if attributes.key?(:'warningStateBackendNames') && attributes.key?(:'warning_state_backend_names') self.warning_state_backend_names = attributes[:'warning_state_backend_names'] if attributes[:'warning_state_backend_names'] self.critical_state_backend_names = attributes[:'criticalStateBackendNames'] if attributes[:'criticalStateBackendNames'] raise 'You cannot provide both :criticalStateBackendNames and :critical_state_backend_names' if attributes.key?(:'criticalStateBackendNames') && attributes.key?(:'critical_state_backend_names') self.critical_state_backend_names = attributes[:'critical_state_backend_names'] if attributes[:'critical_state_backend_names'] self.unknown_state_backend_names = attributes[:'unknownStateBackendNames'] if attributes[:'unknownStateBackendNames'] raise 'You cannot provide both :unknownStateBackendNames and :unknown_state_backend_names' if attributes.key?(:'unknownStateBackendNames') && attributes.key?(:'unknown_state_backend_names') self.unknown_state_backend_names = attributes[:'unknown_state_backend_names'] if attributes[:'unknown_state_backend_names'] self.total_backend_count = attributes[:'totalBackendCount'] if attributes[:'totalBackendCount'] raise 'You cannot provide both :totalBackendCount and :total_backend_count' if attributes.key?(:'totalBackendCount') && attributes.key?(:'total_backend_count') self.total_backend_count = attributes[:'total_backend_count'] if attributes[:'total_backend_count'] end
Attribute type mapping.
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 83 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'status': :'String', 'warning_state_backend_names': :'Array<String>', 'critical_state_backend_names': :'Array<String>', 'unknown_state_backend_names': :'Array<String>', 'total_backend_count': :'Integer' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 159 def ==(other) return true if equal?(other) self.class == other.class && status == other.status && warning_state_backend_names == other.warning_state_backend_names && critical_state_backend_names == other.critical_state_backend_names && unknown_state_backend_names == other.unknown_state_backend_names && total_backend_count == other.total_backend_count end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 193 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 173 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 182 def hash [status, warning_state_backend_names, critical_state_backend_names, unknown_state_backend_names, total_backend_count].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object
to be assigned
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 143 def status=(status) # rubocop:disable Style/ConditionalAssignment if status && !STATUS_ENUM.include?(status) OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger @status = STATUS_UNKNOWN_ENUM_VALUE else @status = status end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 226 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 220 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/network_load_balancer/models/backend_set_health.rb, line 243 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end