org.apache.sling.hc.api.execution

Interface HealthCheckExecutionResult

@ProviderType
public interface HealthCheckExecutionResult

Interface for health check executions via the HealthCheckExecutor. If the execution of the health check timed out, the method

Method Summary

Modifier and Type	Method and Description
long	getElapsedTimeInMs() Get the elapsed time in ms
java.util.Date	getFinishedAt() Get the date, the health check finished or if the execution timed out, the execution was aborted.
HealthCheckMetadata	getHealthCheckMetadata() Get the meta data about the health check service
Result	getHealthCheckResult() Get the result of the health check run.
boolean	hasTimedOut() Returns true if the execution has timed out.

Method Detail

getHealthCheckResult

Result getHealthCheckResult()

Get the result of the health check run.

getElapsedTimeInMs

long getElapsedTimeInMs()

Get the elapsed time in ms

getFinishedAt

java.util.Date getFinishedAt()

Get the date, the health check finished or if the execution timed out, the execution was aborted.

Returns:

The finished date of the execution.

hasTimedOut

boolean hasTimedOut()

Returns true if the execution has timed out. In this case the result does not reflect the real result of the underlying check, but a result indicating the timeout.

Returns:

true if execution timed out.

getHealthCheckMetadata

HealthCheckMetadata getHealthCheckMetadata()

Get the meta data about the health check service