Class: OCI::Healthchecks::Models::HttpProbeResultSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/healthchecks/models/http_probe_result_summary.rb

Overview

The results returned by running an HTTP probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z). Time properties conform to W3C Resource Timing. For more information, see PerformanceResourceTiming interface.

Constant Summary collapse

ERROR_CATEGORY_ENUM =
[
  ERROR_CATEGORY_NONE = 'NONE'.freeze,
  ERROR_CATEGORY_DNS = 'DNS'.freeze,
  ERROR_CATEGORY_TRANSPORT = 'TRANSPORT'.freeze,
  ERROR_CATEGORY_NETWORK = 'NETWORK'.freeze,
  ERROR_CATEGORY_SYSTEM = 'SYSTEM'.freeze,
  ERROR_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PROTOCOL_ENUM =
[
  PROTOCOL_HTTP = 'HTTP'.freeze,
  PROTOCOL_HTTPS = 'HTTPS'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HttpProbeResultSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 259

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

  self.probe_configuration_id = attributes[:'probeConfigurationId'] if attributes[:'probeConfigurationId']

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

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

  self.start_time = attributes[:'startTime'] if attributes[:'startTime']

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

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

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

  self.vantage_point_name = attributes[:'vantagePointName'] if attributes[:'vantagePointName']

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

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

  self.is_timed_out = attributes[:'isTimedOut'] unless attributes[:'isTimedOut'].nil?

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

  self.is_timed_out = attributes[:'is_timed_out'] unless attributes[:'is_timed_out'].nil?

  self.is_healthy = attributes[:'isHealthy'] unless attributes[:'isHealthy'].nil?

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

  self.is_healthy = attributes[:'is_healthy'] unless attributes[:'is_healthy'].nil?

  self.error_category = attributes[:'errorCategory'] if attributes[:'errorCategory']
  self.error_category = "NONE" if error_category.nil? && !attributes.key?(:'errorCategory') # rubocop:disable Style/StringLiterals

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

  self.error_category = attributes[:'error_category'] if attributes[:'error_category']
  self.error_category = "NONE" if error_category.nil? && !attributes.key?(:'errorCategory') && !attributes.key?(:'error_category') # rubocop:disable Style/StringLiterals

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

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

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

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

  self.status_code = attributes[:'statusCode'] if attributes[:'statusCode']

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

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

  self.domain_lookup_start = attributes[:'domainLookupStart'] if attributes[:'domainLookupStart']

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

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

  self.domain_lookup_end = attributes[:'domainLookupEnd'] if attributes[:'domainLookupEnd']

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

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

  self.connect_start = attributes[:'connectStart'] if attributes[:'connectStart']

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

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

  self.secure_connection_start = attributes[:'secureConnectionStart'] if attributes[:'secureConnectionStart']

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

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

  self.connect_end = attributes[:'connectEnd'] if attributes[:'connectEnd']

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

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

  self.fetch_start = attributes[:'fetchStart'] if attributes[:'fetchStart']

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

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

  self.request_start = attributes[:'requestStart'] if attributes[:'requestStart']

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

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

  self.response_start = attributes[:'responseStart'] if attributes[:'responseStart']

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

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

  self.response_end = attributes[:'responseEnd'] if attributes[:'responseEnd']

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

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

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

  self.encoded_body_size = attributes[:'encodedBodySize'] if attributes[:'encodedBodySize']

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

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

Instance Attribute Details

#connect_endFloat

The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.

Returns:

  • (Float)


128
129
130
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 128

def connect_end
  @connect_end
end

#connect_startFloat

The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.

Returns:

  • (Float)


116
117
118
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 116

def connect_start
  @connect_start
end

#connectionOCI::Healthchecks::Models::TcpConnection



91
92
93
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 91

def connection
  @connection
end

#dnsOCI::Healthchecks::Models::DNS



94
95
96
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 94

def dns
  @dns
end

#domain_lookup_endFloat

The time immediately before the vantage point finishes the domain name lookup for the resource.

Returns:

  • (Float)


110
111
112
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 110

def domain_lookup_end
  @domain_lookup_end
end

#domain_lookup_startFloat

The time immediately before the vantage point starts the domain name lookup for the resource.

Returns:

  • (Float)


104
105
106
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 104

def domain_lookup_start
  @domain_lookup_start
end

#durationFloat

The total duration from start of request until response is fully consumed or the connection is closed.

Returns:

  • (Float)


157
158
159
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 157

def duration
  @duration
end

#encoded_body_sizeInteger

The size, in octets, of the payload body prior to removing any applied content-codings.

Returns:

  • (Integer)


163
164
165
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 163

def encoded_body_size
  @encoded_body_size
end

#error_categoryString

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details. * NONE - No error * DNS - DNS errors * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * NETWORK - Network-related errors, for example a "network unreachable" error. * SYSTEM - Internal system errors.

Returns:

  • (String)


81
82
83
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 81

def error_category
  @error_category
end

#error_messageString

The error information indicating why a probe execution failed.

Returns:

  • (String)


85
86
87
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 85

def error_message
  @error_message
end

#fetch_startFloat

The time immediately before the vantage point starts to fetch the resource.

Returns:

  • (Float)


133
134
135
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 133

def fetch_start
  @fetch_start
end

#is_healthyBOOLEAN

True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300.

Returns:

  • (BOOLEAN)


70
71
72
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 70

def is_healthy
  @is_healthy
end

#is_timed_outBOOLEAN

True if the probe did not complete before the configured timeoutInSeconds value.

Returns:

  • (BOOLEAN)


62
63
64
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 62

def is_timed_out
  @is_timed_out
end

#keyString

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

Returns:

  • (String)


36
37
38
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 36

def key
  @key
end

#probe_configuration_idString

The OCID of the monitor or on-demand probe responsible for creating this result.

Returns:

  • (String)


41
42
43
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 41

def probe_configuration_id
  @probe_configuration_id
end

#protocolString

Returns:

  • (String)


88
89
90
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 88

def protocol
  @protocol
end

#request_startFloat

The time immediately before the vantage point starts requesting the resource from the server.

Returns:

  • (Float)


139
140
141
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 139

def request_start
  @request_start
end

#response_endFloat

The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first.

Returns:

  • (Float)


151
152
153
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 151

def response_end
  @response_end
end

#response_startFloat

The time immediately after the vantage point's HTTP parser receives the first byte of the response.

Returns:

  • (Float)


145
146
147
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 145

def response_start
  @response_start
end

#secure_connection_startFloat

The time immediately before the vantage point starts the handshake process to secure the current connection.

Returns:

  • (Float)


122
123
124
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 122

def secure_connection_start
  @secure_connection_start
end

#start_timeFloat

The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see Resource Timing.

Returns:

  • (Float)


49
50
51
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 49

def start_time
  @start_time
end

#status_codeInteger

The HTTP response status code.

Returns:

  • (Integer)


98
99
100
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 98

def status_code
  @status_code
end

#targetString

The target hostname or IP address of the probe.

Returns:

  • (String)


53
54
55
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 53

def target
  @target
end

#vantage_point_nameString

The name of the vantage point that executed the probe.

Returns:

  • (String)


57
58
59
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 57

def vantage_point_name
  @vantage_point_name
end

Class Method Details

.attribute_mapObject

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 166

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'probe_configuration_id': :'probeConfigurationId',
    'start_time': :'startTime',
    'target': :'target',
    'vantage_point_name': :'vantagePointName',
    'is_timed_out': :'isTimedOut',
    'is_healthy': :'isHealthy',
    'error_category': :'errorCategory',
    'error_message': :'errorMessage',
    'protocol': :'protocol',
    'connection': :'connection',
    'dns': :'dns',
    'status_code': :'statusCode',
    'domain_lookup_start': :'domainLookupStart',
    'domain_lookup_end': :'domainLookupEnd',
    'connect_start': :'connectStart',
    'secure_connection_start': :'secureConnectionStart',
    'connect_end': :'connectEnd',
    'fetch_start': :'fetchStart',
    'request_start': :'requestStart',
    'response_start': :'responseStart',
    'response_end': :'responseEnd',
    'duration': :'duration',
    'encoded_body_size': :'encodedBodySize'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 198

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'probe_configuration_id': :'String',
    'start_time': :'Float',
    'target': :'String',
    'vantage_point_name': :'String',
    'is_timed_out': :'BOOLEAN',
    'is_healthy': :'BOOLEAN',
    'error_category': :'String',
    'error_message': :'String',
    'protocol': :'String',
    'connection': :'OCI::Healthchecks::Models::TcpConnection',
    'dns': :'OCI::Healthchecks::Models::DNS',
    'status_code': :'Integer',
    'domain_lookup_start': :'Float',
    'domain_lookup_end': :'Float',
    'connect_start': :'Float',
    'secure_connection_start': :'Float',
    'connect_end': :'Float',
    'fetch_start': :'Float',
    'request_start': :'Float',
    'response_start': :'Float',
    'response_end': :'Float',
    'duration': :'Float',
    'encoded_body_size': :'Integer'
    # 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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 421

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

  self.class == other.class &&
    key == other.key &&
    probe_configuration_id == other.probe_configuration_id &&
    start_time == other.start_time &&
    target == other.target &&
    vantage_point_name == other.vantage_point_name &&
    is_timed_out == other.is_timed_out &&
    is_healthy == other.is_healthy &&
    error_category == other.error_category &&
    error_message == other.error_message &&
    protocol == other.protocol &&
    connection == other.connection &&
    dns == other.dns &&
    status_code == other.status_code &&
    domain_lookup_start == other.domain_lookup_start &&
    domain_lookup_end == other.domain_lookup_end &&
    connect_start == other.connect_start &&
    secure_connection_start == other.secure_connection_start &&
    connect_end == other.connect_end &&
    fetch_start == other.fetch_start &&
    request_start == other.request_start &&
    response_start == other.response_start &&
    response_end == other.response_end &&
    duration == other.duration &&
    encoded_body_size == other.encoded_body_size
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



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 474

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


454
455
456
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 454

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



463
464
465
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 463

def hash
  [key, probe_configuration_id, start_time, target, vantage_point_name, is_timed_out, is_healthy, error_category, error_message, protocol, connection, dns, status_code, domain_lookup_start, domain_lookup_end, connect_start, secure_connection_start, connect_end, fetch_start, request_start, response_start, response_end, duration, encoded_body_size].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



507
508
509
510
511
512
513
514
515
516
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 507

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



501
502
503
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 501

def to_s
  to_hash.to_s
end