@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
PingProbeResultSummary.Builder |
static class |
PingProbeResultSummary.ErrorCategory
The category of error if an error occurs executing the probe.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and 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.
|
| Modifier and Type | Method and 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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)
public static PingProbeResultSummary.Builder builder()
Create a new builder.
public PingProbeResultSummary.Builder toBuilder()
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.
public String getProbeConfigurationId()
The OCID of the monitor or on-demand probe responsible for creating this result.
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.
public String getTarget()
The target hostname or IP address of the probe.
public String getVantagePointName()
The name of the vantage point that executed the probe.
public Boolean getIsTimedOut()
True if the probe did not complete before the configured timeoutInSeconds value.
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.
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.
public String getErrorMessage()
The error information indicating why a probe execution failed.
public PingProbeProtocol getProtocol()
public Connection getConnection()
public DNS getDns()
public Double getDomainLookupStart()
The time immediately before the vantage point starts the domain name lookup for the resource.
public Double getDomainLookupEnd()
The time immediately before the vantage point finishes the domain name lookup for the resource.
public Double getLatencyInMs()
The latency of the probe execution, in milliseconds.
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.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.