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.ExplicitlySetBmcModelThe 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 SummaryNested Classes Modifier and Type Class Description static classHttpProbeResultSummary.Builderstatic classHttpProbeResultSummary.ErrorCategoryThe category of error if an error occurs executing the probe.
 - 
Constructor SummaryConstructors 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 SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HttpProbeResultSummary.Builderbuilder()Create a new builder.booleanequals(Object o)DoublegetConnectEnd()The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.TcpConnectiongetConnection()DoublegetConnectStart()The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.DNSgetDns()DoublegetDomainLookupEnd()The time immediately before the vantage point finishes the domain name lookup for the resource.DoublegetDomainLookupStart()The time immediately before the vantage point starts the domain name lookup for the resource.DoublegetDuration()The total duration from start of request until response is fully consumed or the connection is closed.IntegergetEncodedBodySize()The size, in octets, of the payload body prior to removing any applied content-codings.HttpProbeResultSummary.ErrorCategorygetErrorCategory()The category of error if an error occurs executing the probe.StringgetErrorMessage()The error information indicating why a probe execution failed.DoublegetFetchStart()The time immediately before the vantage point starts to fetch the resource.BooleangetIsHealthy()True if the probe result is determined to be healthy based on probe type-specific criteria.BooleangetIsTimedOut()True if the probe did not complete before the configured timeoutInSeconds value.StringgetKey()A value identifying this specific probe result.StringgetProbeConfigurationId()The OCID of the monitor or on-demand probe responsible for creating this result.HttpProbeProtocolgetProtocol()DoublegetRequestStart()The time immediately before the vantage point starts requesting the resource from the server.DoublegetResponseEnd()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.DoublegetResponseStart()The time immediately after the vantage point’s HTTP parser receives the first byte of the response.DoublegetSecureConnectionStart()The time immediately before the vantage point starts the handshake process to secure the current connection.DoublegetStartTime()The date and time the probe was executed, expressed in milliseconds since the POSIX epoch.IntegergetStatusCode()The HTTP response status code.StringgetTarget()The target hostname or IP address of the probe.StringgetVantagePointName()The name of the vantage point that executed the probe.inthashCode()HttpProbeResultSummary.BuildertoBuilder()StringtoString()StringtoString(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- 
builderpublic static HttpProbeResultSummary.Builder builder() Create a new builder.
 - 
toBuilderpublic HttpProbeResultSummary.Builder toBuilder() 
 - 
getKeypublic 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
 
 - 
getProbeConfigurationIdpublic String getProbeConfigurationId() The OCID of the monitor or on-demand probe responsible for creating this result.- Returns:
- the value
 
 - 
getStartTimepublic 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
 
 - 
getTargetpublic String getTarget() The target hostname or IP address of the probe.- Returns:
- the value
 
 - 
getVantagePointNamepublic String getVantagePointName() The name of the vantage point that executed the probe.- Returns:
- the value
 
 - 
getIsTimedOutpublic Boolean getIsTimedOut() True if the probe did not complete before the configured timeoutInSeconds value.- Returns:
- the value
 
 - 
getIsHealthypublic 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
 
 - 
getErrorCategorypublic 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
 
 - 
getErrorMessagepublic String getErrorMessage() The error information indicating why a probe execution failed.- Returns:
- the value
 
 - 
getProtocolpublic HttpProbeProtocol getProtocol() 
 - 
getConnectionpublic TcpConnection getConnection() 
 - 
getDnspublic DNS getDns() 
 - 
getStatusCodepublic Integer getStatusCode() The HTTP response status code.- Returns:
- the value
 
 - 
getDomainLookupStartpublic Double getDomainLookupStart() The time immediately before the vantage point starts the domain name lookup for the resource.- Returns:
- the value
 
 - 
getDomainLookupEndpublic Double getDomainLookupEnd() The time immediately before the vantage point finishes the domain name lookup for the resource.- Returns:
- the value
 
 - 
getConnectStartpublic Double getConnectStart() The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.- Returns:
- the value
 
 - 
getSecureConnectionStartpublic Double getSecureConnectionStart() The time immediately before the vantage point starts the handshake process to secure the current connection.- Returns:
- the value
 
 - 
getConnectEndpublic Double getConnectEnd() The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.- Returns:
- the value
 
 - 
getFetchStartpublic Double getFetchStart() The time immediately before the vantage point starts to fetch the resource.- Returns:
- the value
 
 - 
getRequestStartpublic Double getRequestStart() The time immediately before the vantage point starts requesting the resource from the server.- Returns:
- the value
 
 - 
getResponseStartpublic Double getResponseStart() The time immediately after the vantage point’s HTTP parser receives the first byte of the response.- Returns:
- the value
 
 - 
getResponseEndpublic 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
 
 - 
getDurationpublic Double getDuration() The total duration from start of request until response is fully consumed or the connection is closed.- Returns:
- the value
 
 - 
getEncodedBodySizepublic Integer getEncodedBodySize() The size, in octets, of the payload body prior to removing any applied content-codings.- Returns:
- the value
 
 - 
toStringpublic String toString() - Overrides:
- toStringin class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 - 
toStringpublic 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
 
 - 
equalspublic boolean equals(Object o) - Overrides:
- equalsin class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 
- 
 
-