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 =

rubocop:disable Metrics/LineLength

[
  HEALTH_CHECK_STATUS_OK = 'OK'.freeze,
  HEALTH_CHECK_STATUS_INVALID_STATUS_CODE = 'INVALID_STATUS_CODE'.freeze,
  HEALTH_CHECK_STATUS_TIMED_OUT = 'TIMED_OUT'.freeze,
  HEALTH_CHECK_STATUS_REGEX_MISMATCH = 'REGEX_MISMATCH'.freeze,
  HEALTH_CHECK_STATUS_CONNECT_FAILED = 'CONNECT_FAILED'.freeze,
  HEALTH_CHECK_STATUS_IO_ERROR = 'IO_ERROR'.freeze,
  HEALTH_CHECK_STATUS_OFFLINE = 'OFFLINE'.freeze,
  HEALTH_CHECK_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  HEALTH_CHECK_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 = {}) ⇒ 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



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
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 82

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.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']

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

Instance Attribute Details

#health_check_status ⇒ String

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

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 26

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.0.0.7`

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 34

def source_ip_address
  @source_ip_address
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 39

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) 


46
47
48
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 46

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'health_check_status': :'healthCheckStatus',
    'source_ip_address': :'sourceIpAddress',
    'subnet_id': :'subnetId',
    'timestamp': :'timestamp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'health_check_status': :'String',
    'source_ip_address': :'String',
    'subnet_id': :'String',
    'timestamp': :'DateTime'
    # 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



131
132
133
134
135
136
137
138
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 131

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# 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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/load_balancer/models/health_check_result.rb', line 152

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/load_balancer/models/health_check_result.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/health_check_result.rb', line 189

def to_s
  to_hash.to_s
end