Class: OCI::Healthchecks::Models::PingProbeResultSummary

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

Overview

The results returned by running a ping probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z).

Constant Summary collapse

ERROR_CATEGORY_ENUM =

rubocop:disable Metrics/LineLength

[
  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_ICMP = 'ICMP'.freeze,
  PROTOCOL_TCP = 'TCP'.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 = {}) ⇒ PingProbeResultSummary

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::Connection) —

    The value to assign to the #connection property

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

    The value to assign to the #dns 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

  • :latency_in_ms (Float) —

    The value to assign to the #latency_in_ms property

  • :icmp_code (Integer) —

    The value to assign to the #icmp_code property



186
187
188
189
190
191
192
193
194
195
196
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 186

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

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

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

  self.icmp_code = attributes[:'icmpCode'] if attributes[:'icmpCode']

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

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

Instance Attribute Details

#connection ⇒ OCI::Healthchecks::Models::Connection

Returns:



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

def connection
  @connection
end

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

Returns:

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


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

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) 


102
103
104
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 102

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) 


96
97
98
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 96

def domain_lookup_start
  @domain_lookup_start
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) 


77
78
79
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 77

def error_category
  @error_category
end

#error_message ⇒ String

The error information indicating why a probe execution failed.

Returns:

  • (String) 


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

def error_message
  @error_message
end

#icmp_code ⇒ Integer

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see [Internet Control Message Protocol (ICMP) Parameters](www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).

Returns:

  • (Integer) 


114
115
116
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 114

def icmp_code
  @icmp_code
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) 


66
67
68
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 66

def is_healthy
  @is_healthy
end

#is_timed_out ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 58

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) 


32
33
34
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 32

def key
  @key
end

#latency_in_ms ⇒ Float

The latency of the probe execution, in milliseconds.

Returns:

  • (Float) 


107
108
109
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 107

def latency_in_ms
  @latency_in_ms
end

#probe_configuration_id ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 37

def probe_configuration_id
  @probe_configuration_id
end

#protocol ⇒ String

Returns:

  • (String) 


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

def protocol
  @protocol
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) 


45
46
47
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 45

def start_time
  @start_time
end

#target ⇒ String

The target hostname or IP address of the probe.

Returns:

  • (String) 


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

def target
  @target
end

#vantage_point_name ⇒ String

The name of the vantage point that executed the probe.

Returns:

  • (String) 


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

def vantage_point_name
  @vantage_point_name
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 117

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',
    'domain_lookup_start': :'domainLookupStart',
    'domain_lookup_end': :'domainLookupEnd',
    'latency_in_ms': :'latencyInMs',
    'icmp_code': :'icmpCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 141

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::Connection',
    'dns': :'OCI::Healthchecks::Models::DNS',
    'domain_lookup_start': :'Float',
    'domain_lookup_end': :'Float',
    'latency_in_ms': :'Float',
    'icmp_code': :'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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 308

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 &&
    domain_lookup_start == other.domain_lookup_start &&
    domain_lookup_end == other.domain_lookup_end &&
    latency_in_ms == other.latency_in_ms &&
    icmp_code == other.icmp_code
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 353

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


333
334
335
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 333

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 342

def hash
  [key, probe_configuration_id, start_time, target, vantage_point_name, is_timed_out, is_healthy, error_category, error_message, protocol, connection, dns, domain_lookup_start, domain_lookup_end, latency_in_ms, icmp_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 386

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



380
381
382
 
# File 'lib/oci/healthchecks/models/ping_probe_result_summary.rb', line 380

def to_s
  to_hash.to_s
end