RetryableAction.ActionType: Add javadoc

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I582c892eaa5040ee0a17c019bdb4f7078569d7d7
This commit is contained in:
Edwin Kempin
2019-12-11 16:39:09 +01:00
parent 6b92574bf2
commit 7e10a0b149

View File

@@ -37,6 +37,17 @@ import java.util.function.Predicate;
* retry via {@link #retryOn(Predicate)}.
*/
public class RetryableAction<T> {
/**
* Type of an retryable action.
*
* <p>The action type is used for two purposes:
*
* <ul>
* <li>to determine the default timeout for executing the action (see {@link
* RetryHelper#getDefaultTimeout(String)})
* <li>as bucket for all retry metrics (see {@link RetryHelper.Metrics})
* </ul>
*/
public enum ActionType {
ACCOUNT_UPDATE,
CHANGE_UPDATE,