Package com.oracle.bmc.healthchecks.model

Class PingProbeResultSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.healthchecks.model.PingProbeResultSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180501")
public final class PingProbeResultSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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).
Note: Objects should always be created or deserialized using the PingProbeResultSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PingProbeResultSummary.Builder, which maintain a set of all explicitly set fields called PingProbeResultSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PingProbeResultSummary.Builder
static class	PingProbeResultSummary.ErrorCategory	The category of error if an error occurs executing the probe.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
PingProbeResultSummary(String key, String probeConfigurationId, Double startTime, String target, String vantagePointName, Boolean isTimedOut, Boolean isHealthy, PingProbeResultSummary.ErrorCategory errorCategory, String errorMessage, PingProbeProtocol protocol, Connection connection, DNS dns, Double domainLookupStart, Double domainLookupEnd, Double latencyInMs, Integer icmpCode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PingProbeResultSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Connection	getConnection()
DNS	getDns()
Double	getDomainLookupEnd()	The time immediately before the vantage point finishes the domain name lookup for the resource.
Double	getDomainLookupStart()	The time immediately before the vantage point starts the domain name lookup for the resource.
PingProbeResultSummary.ErrorCategory	getErrorCategory()	The category of error if an error occurs executing the probe.
String	getErrorMessage()	The error information indicating why a probe execution failed.
Integer	getIcmpCode()	The ICMP code of the response message.
Boolean	getIsHealthy()	True if the probe result is determined to be healthy based on probe type-specific criteria.
Boolean	getIsTimedOut()	True if the probe did not complete before the configured timeoutInSeconds value.
String	getKey()	A value identifying this specific probe result.
Double	getLatencyInMs()	The latency of the probe execution, in milliseconds.
String	getProbeConfigurationId()	The OCID of the monitor or on-demand probe responsible for creating this result.
PingProbeProtocol	getProtocol()
Double	getStartTime()	The date and time the probe was executed, expressed in milliseconds since the POSIX epoch.
String	getTarget()	The target hostname or IP address of the probe.
String	getVantagePointName()	The name of the vantage point that executed the probe.
int	hashCode()
PingProbeResultSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PingProbeResultSummary

@Deprecated
@ConstructorProperties({"key","probeConfigurationId","startTime","target","vantagePointName","isTimedOut","isHealthy","errorCategory","errorMessage","protocol","connection","dns","domainLookupStart","domainLookupEnd","latencyInMs","icmpCode"})
public PingProbeResultSummary(String key,
                              String probeConfigurationId,
                              Double startTime,
                              String target,
                              String vantagePointName,
                              Boolean isTimedOut,
                              Boolean isHealthy,
                              PingProbeResultSummary.ErrorCategory errorCategory,
                              String errorMessage,
                              PingProbeProtocol protocol,
                              Connection connection,
                              DNS dns,
                              Double domainLookupStart,
                              Double domainLookupEnd,
                              Double latencyInMs,
                              Integer icmpCode)

Deprecated.

Method Detail

builder

public static PingProbeResultSummary.Builder builder()

Create a new builder.

toBuilder

public PingProbeResultSummary.Builder toBuilder()

getKey

public String getKey()

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:

the value

getProbeConfigurationId

public String getProbeConfigurationId()

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

Returns:

the value

getStartTime

public Double getStartTime()

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:

the value

getTarget

public String getTarget()

The target hostname or IP address of the probe.

Returns:

the value

getVantagePointName

public String getVantagePointName()

The name of the vantage point that executed the probe.

Returns:

the value

getIsTimedOut

public Boolean getIsTimedOut()

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

Returns:

the value

getIsHealthy

public Boolean getIsHealthy()

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:

the value

getErrorCategory

public PingProbeResultSummary.ErrorCategory getErrorCategory()

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:

the value

getErrorMessage

public String getErrorMessage()

The error information indicating why a probe execution failed.

Returns:

the value

getProtocol

public PingProbeProtocol getProtocol()

getConnection

public Connection getConnection()

getDns

public DNS getDns()

getDomainLookupStart

public Double getDomainLookupStart()

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

Returns:

the value

getDomainLookupEnd

public Double getDomainLookupEnd()

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

Returns:

the value

getLatencyInMs

public Double getLatencyInMs()

The latency of the probe execution, in milliseconds.

Returns:

the value

getIcmpCode

public Integer getIcmpCode()

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel