Class: OCI::LoadBalancer::Models::HealthCheckResult

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

Overview

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

Constant Summary collapse

HEALTH_CHECK_STATUS_ENUM = 
[HEALTH_CHECK_STATUS_OK = 'OK',
HEALTH_CHECK_STATUS_INVALID_STATUS_CODE = 'INVALID_STATUS_CODE',
HEALTH_CHECK_STATUS_TIMED_OUT = 'TIMED_OUT',
HEALTH_CHECK_STATUS_REGEX_MISMATCH = 'REGEX_MISMATCH',
HEALTH_CHECK_STATUS_CONNECT_FAILED = 'CONNECT_FAILED',
HEALTH_CHECK_STATUS_IO_ERROR = 'IO_ERROR',
HEALTH_CHECK_STATUS_OFFLINE = 'OFFLINE',
HEALTH_CHECK_STATUS_UNKNOWN = 'UNKNOWN',
HEALTH_CHECK_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HealthCheckResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :health_check_status (String) —

    The value to assign to the #health_check_status property

  • :source_ip_address (String) —

    The value to assign to the #source_ip_address property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 52

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#health_check_status ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 23

def health_check_status
  @health_check_status
end

#source_ip_address ⇒ String

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

Example: ‘10.2.0.1`

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 31

def source_ip_address
  @source_ip_address
end

#subnet_id ⇒ String

[Required] The OCID of the subnet hosting the load balancer that reported this health check status.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 36

def subnet_id
  @subnet_id
end

#timestamp ⇒ DateTime

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

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

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 43

def timestamp
  @timestamp
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



106
107
108
109
110
111
112
113
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 106

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 130

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


117
118
119
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 117

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [health_check_status, source_ip_address, subnet_id, timestamp].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 155

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



149
150
151
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 149

def to_s
  to_hash.to_s
end