Class PingProbeResultSummary

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).

Inheritance

object

PingProbeResultSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.HealthchecksService.Models

Assembly: OCI.DotNetSDK.Healthchecks.dll

Syntax

public class PingProbeResultSummary

Properties

Connection

Declaration

[JsonProperty(PropertyName = "connection")]
public Connection Connection { get; set; }

Property Value

Type	Description
Connection

Dns

Declaration

[JsonProperty(PropertyName = "dns")]
public DNS Dns { get; set; }

Property Value

Type	Description
DNS

DomainLookupEnd

Declaration

[JsonProperty(PropertyName = "domainLookupEnd")]
public double DomainLookupEnd { get; set; }

Property Value

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

DomainLookupStart

Declaration

[JsonProperty(PropertyName = "domainLookupStart")]
public double DomainLookupStart { get; set; }

Property Value

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

ErrorCategory

Declaration

[JsonProperty(PropertyName = "errorCategory")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PingProbeResultSummary.ErrorCategoryEnum? ErrorCategory { get; set; }

Property Value

Type Description

Type	Description
PingProbeResultSummary.ErrorCategoryEnum?	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.

PingProbeResultSummary.ErrorCategoryEnum?

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.

ErrorMessage

Declaration

[JsonProperty(PropertyName = "errorMessage")]
public string ErrorMessage { get; set; }

Property Value

Type	Description
string	The error information indicating why a probe execution failed.

IcmpCode

Declaration

[JsonProperty(PropertyName = "icmpCode")]
public int? IcmpCode { get; set; }

Property Value

Type	Description
int?	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.

IsHealthy

Declaration

[JsonProperty(PropertyName = "isHealthy")]
public bool? IsHealthy { get; set; }

Property Value

Type	Description
bool?	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.

IsTimedOut

Declaration

[JsonProperty(PropertyName = "isTimedOut")]
public bool? IsTimedOut { get; set; }

Property Value

Type	Description
bool?	True if the probe did not complete before the configured `timeoutInSeconds` value.

Key

Declaration

[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
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.

LatencyInMs

Declaration

[JsonProperty(PropertyName = "latencyInMs")]
public double LatencyInMs { get; set; }

Property Value

Type	Description
double	The latency of the probe execution, in milliseconds.

ProbeConfigurationId

Declaration

[JsonProperty(PropertyName = "probeConfigurationId")]
public string ProbeConfigurationId { get; set; }

Property Value

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

Protocol

Declaration

[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PingProbeProtocol? Protocol { get; set; }

Property Value

Type	Description
PingProbeProtocol?

StartTime

Declaration

[JsonProperty(PropertyName = "startTime")]
public double StartTime { get; set; }

Property Value

Type	Description
double	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.

Target

Declaration

[JsonProperty(PropertyName = "target")]
public string Target { get; set; }

Property Value

Type	Description
string	The target hostname or IP address of the probe.

VantagePointName

Declaration

[JsonProperty(PropertyName = "vantagePointName")]
public string VantagePointName { get; set; }

Property Value

Type	Description
string	The name of the vantage point that executed the probe.