Class HttpProbeResultSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.healthchecks.model.HttpProbeResultSummary
-
@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 theHttpProbeResultSummary.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 theHttpProbeResultSummary.Builder
, which maintain a set of all explicitly set fields calledHttpProbeResultSummary.Builder.__explicitlySet__
. ThehashCode()
andequals(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
HttpProbeResultSummary.Builder
static class
HttpProbeResultSummary.ErrorCategory
The category of error if an error occurs executing the probe.
-
Constructor Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Constructor Detail
-
HttpProbeResultSummary
@Deprecated @ConstructorProperties({"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)
Deprecated.
-
-
Method Detail
-
builder
public static HttpProbeResultSummary.Builder builder()
Create a new builder.
-
toBuilder
public HttpProbeResultSummary.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 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.
- Returns:
- the value
-
getErrorMessage
public String getErrorMessage()
The error information indicating why a probe execution failed.- Returns:
- the value
-
getProtocol
public HttpProbeProtocol getProtocol()
-
getConnection
public TcpConnection getConnection()
-
getDns
public DNS getDns()
-
getStatusCode
public Integer getStatusCode()
The HTTP response status code.- Returns:
- the value
-
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
-
getConnectStart
public Double getConnectStart()
The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.- Returns:
- the value
-
getSecureConnectionStart
public Double getSecureConnectionStart()
The time immediately before the vantage point starts the handshake process to secure the current connection.- Returns:
- the value
-
getConnectEnd
public Double getConnectEnd()
The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.- Returns:
- the value
-
getFetchStart
public Double getFetchStart()
The time immediately before the vantage point starts to fetch the resource.- Returns:
- the value
-
getRequestStart
public Double getRequestStart()
The time immediately before the vantage point starts requesting the resource from the server.- Returns:
- the value
-
getResponseStart
public Double getResponseStart()
The time immediately after the vantage point’s HTTP parser receives the first byte of the response.- Returns:
- the value
-
getResponseEnd
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.- Returns:
- the value
-
getDuration
public Double getDuration()
The total duration from start of request until response is fully consumed or the connection is closed.- Returns:
- the value
-
getEncodedBodySize
public Integer getEncodedBodySize()
The size, in octets, of the payload body prior to removing any applied content-codings.- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-