Annotation Type Async
-
@Retention(RUNTIME) @Target(TYPE) public @interface Async
An annotation for marking asynchronous health check execution.
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description longperiodPeriod between executions.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description longhealthyTtlHow long a healthy result is considered valid before being ignored.longinitialDelayInitial delay of first execution.Async.InitialStateinitialStateInitial health state until first asynchronous execution completes.Async.ScheduleTypescheduleTypeScheduling type of asynchronous executions.TimeUnitunitTime unit of initial delay, period and healthyTtl.
-
-
-
-
scheduleType
Async.ScheduleType scheduleType
Scheduling type of asynchronous executions.- Returns:
- schedule type
- Default:
- com.codahale.metrics.health.annotation.Async.ScheduleType.FIXED_RATE
-
-
-
unit
TimeUnit unit
Time unit of initial delay, period and healthyTtl.- Returns:
- time unit
- Default:
- java.util.concurrent.TimeUnit.SECONDS
-
-
-
initialState
Async.InitialState initialState
Initial health state until first asynchronous execution completes.- Returns:
- initial health state
- Default:
- com.codahale.metrics.health.annotation.Async.InitialState.HEALTHY
-
-