Interface HealthCheckExecutionResult
-
@ProviderType public interface HealthCheckExecutionResult
Interface for health check executions via theHealthCheckExecutor
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getElapsedTimeInMs()
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 serviceResult
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.- Returns:
- the plain result
Result
-
getElapsedTimeInMs
long getElapsedTimeInMs()
- Returns:
- 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- Returns:
- The
HealthCheckMetadata
the result was created for.
-
-