@Generated(value="OracleSDKGenerator",
comments="API Version: 20180501")
public final class HttpProbeResultSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the HttpProbeResultSummary.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 HttpProbeResultSummary.Builder, which maintain a
set of all explicitly set fields called HttpProbeResultSummary.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 |
HttpProbeResultSummary.Builder |
static class |
HttpProbeResultSummary.ErrorCategory
The category of error if an error occurs executing the probe.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
HttpProbeResultSummary(String key,
String probeConfigurationId,
Double startTime,
String target,
String vantagePointName,
Boolean isTimedOut,
Boolean isHealthy,
HttpProbeResultSummary.ErrorCategory errorCategory,
String errorMessage,
HttpProbeProtocol protocol,
TcpConnection connection,
DNS dns,
Integer statusCode,
Double domainLookupStart,
Double domainLookupEnd,
Double connectStart,
Double secureConnectionStart,
Double connectEnd,
Double fetchStart,
Double requestStart,
Double responseStart,
Double responseEnd,
Double duration,
Integer encodedBodySize)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static HttpProbeResultSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Double |
getConnectEnd()
The time immediately after the vantage point finishes establishing the connection to the
server to retrieve the resource.
|
TcpConnection |
getConnection() |
Double |
getConnectStart()
The time immediately before the vantage point starts establishing the connection to the
server to retrieve the resource.
|
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.
|
Double |
getDuration()
The total duration from start of request until response is fully consumed or the connection
is closed.
|
Integer |
getEncodedBodySize()
The size, in octets, of the payload body prior to removing any applied content-codings.
|
HttpProbeResultSummary.ErrorCategory |
getErrorCategory()
The category of error if an error occurs executing the probe.
|
String |
getErrorMessage()
The error information indicating why a probe execution failed.
|
Double |
getFetchStart()
The time immediately before the vantage point starts to fetch the resource.
|
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.
|
String |
getProbeConfigurationId()
The OCID of the monitor or on-demand probe responsible for creating this result.
|
HttpProbeProtocol |
getProtocol() |
Double |
getRequestStart()
The time immediately before the vantage point starts requesting the resource from the server.
|
Double |
getResponseEnd()
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.
|
Double |
getResponseStart()
The time immediately after the vantage point’s HTTP parser receives the first byte of the
response.
|
Double |
getSecureConnectionStart()
The time immediately before the vantage point starts the handshake process to secure the
current connection.
|
Double |
getStartTime()
The date and time the probe was executed, expressed in milliseconds since the POSIX epoch.
|
Integer |
getStatusCode()
The HTTP response status code.
|
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() |
HttpProbeResultSummary.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","statusCode","domainLookupStart","domainLookupEnd","connectStart","secureConnectionStart","connectEnd","fetchStart","requestStart","responseStart","responseEnd","duration","encodedBodySize"}) public HttpProbeResultSummary(String key, String probeConfigurationId, Double startTime, String target, String vantagePointName, Boolean isTimedOut, Boolean isHealthy, HttpProbeResultSummary.ErrorCategory errorCategory, String errorMessage, HttpProbeProtocol protocol, TcpConnection connection, DNS dns, Integer statusCode, Double domainLookupStart, Double domainLookupEnd, Double connectStart, Double secureConnectionStart, Double connectEnd, Double fetchStart, Double requestStart, Double responseStart, Double responseEnd, Double duration, Integer encodedBodySize)
public static HttpProbeResultSummary.Builder builder()
Create a new builder.
public HttpProbeResultSummary.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 HttpProbeResultSummary.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 HttpProbeProtocol getProtocol()
public TcpConnection getConnection()
public DNS getDns()
public Integer getStatusCode()
The HTTP response status code.
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 getConnectStart()
The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.
public Double getSecureConnectionStart()
The time immediately before the vantage point starts the handshake process to secure the current connection.
public Double getConnectEnd()
The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.
public Double getFetchStart()
The time immediately before the vantage point starts to fetch the resource.
public Double getRequestStart()
The time immediately before the vantage point starts requesting the resource from the server.
public Double getResponseStart()
The time immediately after the vantage point’s HTTP parser receives the first byte of the response.
public Double getResponseEnd()
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.
public Double getDuration()
The total duration from start of request until response is fully consumed or the connection is closed.
public Integer getEncodedBodySize()
The size, in octets, of the payload body prior to removing any applied content-codings.
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.