class OCI::LoadBalancer::Models::HealthCheckResult

Information about a single backend server health check result reported by a load balancer.

Constants

HEALTH_CHECK_STATUS_ENUM

Attributes

health_check_status[R]

[Required] The result of the most recent health check.

@return [String]

source_ip_address[RW]

[Required] The IP address of the health check status report provider. This identifier helps you differentiate same-subnet load balancers that report health check status.

Example: `10.0.0.7`

@return [String]

subnet_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status.

@return [String]

timestamp[RW]

[Required] The date and time the data was retrieved, in the format defined by RFC3339.

Example: `2017-06-02T18:28:11+00:00`

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/load_balancer/models/health_check_result.rb, line 50
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'subnet_id': :'subnetId',
    'source_ip_address': :'sourceIpAddress',
    'timestamp': :'timestamp',
    'health_check_status': :'healthCheckStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :subnet_id The value to assign to the {#subnet_id} property @option attributes [String] :source_ip_address The value to assign to the {#source_ip_address} property @option attributes [DateTime] :timestamp The value to assign to the {#timestamp} property @option attributes [String] :health_check_status The value to assign to the {#health_check_status} property

# File lib/oci/load_balancer/models/health_check_result.rb, line 83
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.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.source_ip_address = attributes[:'sourceIpAddress'] if attributes[:'sourceIpAddress']

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

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

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

  self.health_check_status = attributes[:'healthCheckStatus'] if attributes[:'healthCheckStatus']

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

  self.health_check_status = attributes[:'health_check_status'] if attributes[:'health_check_status']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/load_balancer/models/health_check_result.rb, line 62
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'subnet_id': :'String',
    'source_ip_address': :'String',
    'timestamp': :'DateTime',
    'health_check_status': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/health_check_result.rb, line 130
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    subnet_id == other.subnet_id &&
    source_ip_address == other.source_ip_address &&
    timestamp == other.timestamp &&
    health_check_status == other.health_check_status
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/load_balancer/models/health_check_result.rb, line 163
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/health_check_result.rb, line 143
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/load_balancer/models/health_check_result.rb, line 152
def hash
  [subnet_id, source_ip_address, timestamp, health_check_status].hash
end
health_check_status=(health_check_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] health_check_status Object to be assigned

# File lib/oci/load_balancer/models/health_check_result.rb, line 114
def health_check_status=(health_check_status)
  # rubocop:disable Style/ConditionalAssignment
  if health_check_status && !HEALTH_CHECK_STATUS_ENUM.include?(health_check_status)
    OCI.logger.debug("Unknown value for 'health_check_status' [" + health_check_status + "]. Mapping to 'HEALTH_CHECK_STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @health_check_status = HEALTH_CHECK_STATUS_UNKNOWN_ENUM_VALUE
  else
    @health_check_status = health_check_status
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/load_balancer/models/health_check_result.rb, line 196
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/load_balancer/models/health_check_result.rb, line 190
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/load_balancer/models/health_check_result.rb, line 213
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