com.oracle.bmc.healthchecks.model

Class PingProbeResultSummary.Builder

java.lang.Object

com.oracle.bmc.healthchecks.model.PingProbeResultSummary.Builder

Enclosing class:

PingProbeResultSummary

public static class PingProbeResultSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PingProbeResultSummary	build()
PingProbeResultSummary.Builder	connection(Connection connection)
PingProbeResultSummary.Builder	copy(PingProbeResultSummary model)
PingProbeResultSummary.Builder	dns(DNS dns)
PingProbeResultSummary.Builder	domainLookupEnd(Double domainLookupEnd) The time immediately before the vantage point finishes the domain name lookup for the resource.
PingProbeResultSummary.Builder	domainLookupStart(Double domainLookupStart) The time immediately before the vantage point starts the domain name lookup for the resource.
PingProbeResultSummary.Builder	errorCategory(PingProbeResultSummary.ErrorCategory errorCategory) The category of error if an error occurs executing the probe.
PingProbeResultSummary.Builder	errorMessage(String errorMessage) The error information indicating why a probe execution failed.
PingProbeResultSummary.Builder	icmpCode(Integer icmpCode) The ICMP code of the response message.
PingProbeResultSummary.Builder	isHealthy(Boolean isHealthy) True if the probe result is determined to be healthy based on probe type-specific criteria.
PingProbeResultSummary.Builder	isTimedOut(Boolean isTimedOut) True if the probe did not complete before the configured timeoutInSeconds value.
PingProbeResultSummary.Builder	key(String key) A value identifying this specific probe result.
PingProbeResultSummary.Builder	latencyInMs(Double latencyInMs) The latency of the probe execution, in milliseconds.
PingProbeResultSummary.Builder	probeConfigurationId(String probeConfigurationId) The OCID of the monitor or on-demand probe responsible for creating this result.
PingProbeResultSummary.Builder	protocol(PingProbeProtocol protocol)
PingProbeResultSummary.Builder	startTime(Double startTime) The date and time the probe was executed, expressed in milliseconds since the POSIX epoch.
PingProbeResultSummary.Builder	target(String target) The target hostname or IP address of the probe.
PingProbeResultSummary.Builder	vantagePointName(String vantagePointName) The name of the vantage point that executed the probe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

key

public PingProbeResultSummary.Builder key(String key)

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.

Parameters:

key - the value to set

Returns:

this builder

probeConfigurationId

public PingProbeResultSummary.Builder probeConfigurationId(String probeConfigurationId)

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

Parameters:

probeConfigurationId - the value to set

Returns:

this builder

startTime

public PingProbeResultSummary.Builder startTime(Double startTime)

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.

Parameters:

startTime - the value to set

Returns:

this builder

target

public PingProbeResultSummary.Builder target(String target)

The target hostname or IP address of the probe.

Parameters:

target - the value to set

Returns:

this builder

vantagePointName

public PingProbeResultSummary.Builder vantagePointName(String vantagePointName)

The name of the vantage point that executed the probe.

Parameters:

vantagePointName - the value to set

Returns:

this builder

isTimedOut

public PingProbeResultSummary.Builder isTimedOut(Boolean isTimedOut)

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

Parameters:

isTimedOut - the value to set

Returns:

this builder

isHealthy

public PingProbeResultSummary.Builder isHealthy(Boolean isHealthy)

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.

Parameters:

isHealthy - the value to set

Returns:

this builder

errorCategory

public PingProbeResultSummary.Builder errorCategory(PingProbeResultSummary.ErrorCategory errorCategory)

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.

Parameters:

errorCategory - the value to set

Returns:

this builder

errorMessage

public PingProbeResultSummary.Builder errorMessage(String errorMessage)

The error information indicating why a probe execution failed.

Parameters:

errorMessage - the value to set

Returns:

this builder

protocol

public PingProbeResultSummary.Builder protocol(PingProbeProtocol protocol)

connection

public PingProbeResultSummary.Builder connection(Connection connection)

dns

public PingProbeResultSummary.Builder dns(DNS dns)

domainLookupStart

public PingProbeResultSummary.Builder domainLookupStart(Double domainLookupStart)

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

Parameters:

domainLookupStart - the value to set

Returns:

this builder

domainLookupEnd

public PingProbeResultSummary.Builder domainLookupEnd(Double domainLookupEnd)

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

Parameters:

domainLookupEnd - the value to set

Returns:

this builder

latencyInMs

public PingProbeResultSummary.Builder latencyInMs(Double latencyInMs)

The latency of the probe execution, in milliseconds.

Parameters:

latencyInMs - the value to set

Returns:

this builder

icmpCode

public PingProbeResultSummary.Builder icmpCode(Integer icmpCode)

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.

Parameters:

icmpCode - the value to set

Returns:

this builder

build

public PingProbeResultSummary build()

copy

public PingProbeResultSummary.Builder copy(PingProbeResultSummary model)