Class HttpProbeResultSummary

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.

Inheritance

object

HttpProbeResultSummary

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 HttpProbeResultSummary

Properties

ConnectEnd

Declaration

[JsonProperty(PropertyName = "connectEnd")]
public double ConnectEnd { get; set; }

Property Value

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

ConnectStart

Declaration

[JsonProperty(PropertyName = "connectStart")]
public double ConnectStart { get; set; }

Property Value

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

Connection

Declaration

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

Property Value

Type	Description
TcpConnection

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.

Duration

Declaration

[JsonProperty(PropertyName = "duration")]
public double Duration { get; set; }

Property Value

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

EncodedBodySize

Declaration

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

Property Value

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

ErrorCategory

Declaration

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

Property Value

Type Description

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

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

FetchStart

Declaration

[JsonProperty(PropertyName = "fetchStart")]
public double FetchStart { get; set; }

Property Value

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

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.

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 HttpProbeProtocol? Protocol { get; set; }

Property Value

Type	Description
HttpProbeProtocol?

RequestStart

Declaration

[JsonProperty(PropertyName = "requestStart")]
public double RequestStart { get; set; }

Property Value

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

ResponseEnd

Declaration

[JsonProperty(PropertyName = "responseEnd")]
public double ResponseEnd { get; set; }

Property Value

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

ResponseStart

Declaration

[JsonProperty(PropertyName = "responseStart")]
public double ResponseStart { get; set; }

Property Value

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

SecureConnectionStart

Declaration

[JsonProperty(PropertyName = "secureConnectionStart")]
public double SecureConnectionStart { get; set; }

Property Value

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

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.

StatusCode

Declaration

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

Property Value

Type	Description
int?	The HTTP response status code.

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.