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](w3c.github.io/resource-timing/#sec-resource-timing) 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):

  • :key (String) —

    The value to assign to the #key property

  • :probe_configuration_id (String) —

    The value to assign to the #probe_configuration_id property

  • :start_time (Float) —

    The value to assign to the #start_time property

  • :target (String) —

    The value to assign to the #target property

  • :vantage_point_name (String) —

    The value to assign to the #vantage_point_name property

  • :is_timed_out (BOOLEAN) —

    The value to assign to the #is_timed_out property

  • :is_healthy (BOOLEAN) —

    The value to assign to the #is_healthy property

  • :error_category (String) —

    The value to assign to the #error_category property

  • :error_message (String) —

    The value to assign to the #error_message property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :connection (OCI::Healthchecks::Models::TcpConnection) —

    The value to assign to the #connection property

  • :dns (OCI::Healthchecks::Models::DNS) —

    The value to assign to the #dns property

  • :status_code (Integer) —

    The value to assign to the #status_code property

  • :domain_lookup_start (Float) —

    The value to assign to the #domain_lookup_start property

  • :domain_lookup_end (Float) —

    The value to assign to the #domain_lookup_end property

  • :connect_start (Float) —

    The value to assign to the #connect_start property

  • :secure_connection_start (Float) —

    The value to assign to the #secure_connection_start property

  • :connect_end (Float) —

    The value to assign to the #connect_end property

  • :fetch_start (Float) —

    The value to assign to the #fetch_start property

  • :request_start (Float) —

    The value to assign to the #request_start property

  • :response_start (Float) —

    The value to assign to the #response_start property

  • :response_end (Float) —

    The value to assign to the #response_end property

  • :duration (Float) —

    The value to assign to the #duration property

  • :encoded_body_size (Integer) —

    The value to assign to the #encoded_body_size property



258
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
 
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 258

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_end ⇒ Float

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

Returns:

  • (Float) 


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

def connect_end
  @connect_end
end

#connect_start ⇒ Float

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

Returns:

  • (Float) 


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

def connect_start
  @connect_start
end

#connection ⇒ OCI::Healthchecks::Models::TcpConnection

Returns:



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

def connection
  @connection
end

#dns ⇒ OCI::Healthchecks::Models::DNS

Returns:

  • (OCI::Healthchecks::Models::DNS) 


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

def dns
  @dns
end

#domain_lookup_end ⇒ Float

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

Returns:

  • (Float) 


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

def domain_lookup_end
  @domain_lookup_end
end

#domain_lookup_start ⇒ Float

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

Returns:

  • (Float) 


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

def domain_lookup_start
  @domain_lookup_start
end

#duration ⇒ Float

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

Returns:

  • (Float) 


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

def duration
  @duration
end

#encoded_body_size ⇒ Integer

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

Returns:

  • (Integer) 


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

def encoded_body_size
  @encoded_body_size
end

#error_category ⇒ String

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) 


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

def error_category
  @error_category
end

#error_message ⇒ String

The error information indicating why a probe execution failed.

Returns:

  • (String) 


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

def error_message
  @error_message
end

#fetch_start ⇒ Float

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

Returns:

  • (Float) 


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

def fetch_start
  @fetch_start
end

#is_healthy ⇒ BOOLEAN

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) 


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

def is_healthy
  @is_healthy
end

#is_timed_out ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_timed_out
  @is_timed_out
end

#key ⇒ String

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) 


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

def key
  @key
end

#probe_configuration_id ⇒ String

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

Returns:

  • (String) 


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

def probe_configuration_id
  @probe_configuration_id
end

#protocol ⇒ String

Returns:

  • (String) 


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

def protocol
  @protocol
end

#request_start ⇒ Float

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

Returns:

  • (Float) 


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

def request_start
  @request_start
end

#response_end ⇒ Float

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) 


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

def response_end
  @response_end
end

#response_start ⇒ Float

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

Returns:

  • (Float) 


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

def response_start
  @response_start
end

#secure_connection_start ⇒ Float

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

Returns:

  • (Float) 


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

def secure_connection_start
  @secure_connection_start
end

#start_time ⇒ Float

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](w3c.github.io/resource-timing/#sec-resource-timing).

Returns:

  • (Float) 


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

def start_time
  @start_time
end

#status_code ⇒ Integer

The HTTP response status code.

Returns:

  • (Integer) 


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

def status_code
  @status_code
end

#target ⇒ String

The target hostname or IP address of the probe.

Returns:

  • (String) 


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

def target
  @target
end

#vantage_point_name ⇒ String

The name of the vantage point that executed the probe.

Returns:

  • (String) 


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

def vantage_point_name
  @vantage_point_name
end

Class Method Details

.attribute_map ⇒ Object

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



165
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
 
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 165

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_types ⇒ Object

Attribute type mapping.



197
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
 
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 197

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



420
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
 
# File 'lib/oci/healthchecks/models/http_probe_result_summary.rb', line 420

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



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

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



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

def to_s
  to_hash.to_s
end