Package com.couchbase.client.core.retry
Enum RetryReason
- java.lang.Object
-
- java.lang.Enum<RetryReason>
-
- com.couchbase.client.core.retry.RetryReason
-
- All Implemented Interfaces:
Serializable
,Comparable<RetryReason>
@Volatile public enum RetryReason extends Enum<RetryReason>
Provides more insight into why an operation has been retried.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANALYTICS_TEMPORARY_FAILURE
The analytics service reports temporary failure.BUCKET_NOT_AVAILABLE
If the bucket is not available, for example if it is currently in the process of being opened.BUCKET_OPEN_IN_PROGRESS
If a concurrent bucket open is in progress.CHANNEL_CLOSED_WHILE_IN_FLIGHT
The underlying channel on the endpoint closed while this operation was still in-flight and we do not have a response yet.COLLECTION_MAP_REFRESH_IN_PROGRESS
Collection map refresh is in progress.COLLECTION_NOT_FOUND
If a collection is requested but not found in the collection map.ENDPOINT_CIRCUIT_OPEN
Short circuits the endpoint write because the circuit breaker is open at the moment.ENDPOINT_NOT_AVAILABLE
Retried because at the point in time there was no endpoint available to dispatch to.ENDPOINT_NOT_WRITABLE
The endpoint is connected, but for some reason cannot be written to at the moment.ENDPOINT_TEMPORARILY_NOT_AVAILABLE
Deprecated.GLOBAL_CONFIG_LOAD_IN_PROGRESS
If a concurrent global config load is in progress.KV_COLLECTION_OUTDATED
The collection identifier for the KV service has been outdated.KV_ERROR_MAP_INDICATED
The KV error map indicated a retry action on an unknown response code.KV_LOCKED
Server response indicates a locked document.KV_NOT_MY_VBUCKET
A KV "not my vbucket" response has been received.KV_SYNC_WRITE_IN_PROGRESS
Server response indicates a sync write in progress.KV_SYNC_WRITE_RE_COMMIT_IN_PROGRESS
Server response a sync write re-commit in progress.KV_TEMPORARY_FAILURE
Server response indicates a temporary failure.NODE_NOT_AVAILABLE
Retried because at this point in time there is no node available to dispatch to.NOT_PIPELINED_REQUEST_IN_FLIGHT
The request has been dispatched into a non-pipelined handler and a request is currently in-flight so it cannot be dispatched right now onto the same socket.QUERY_ERROR_RETRYABLE
Server indicated that the query failed, but it is retryable.QUERY_INDEX_NOT_FOUND
A query index that is temporarily not found.QUERY_PREPARED_STATEMENT_FAILURE
A prepared statement failure that can be retried.QUERY_TRANSACTION_BUFFER_FULL
The query service has a buffer of statements per-transaction, which is full.SEARCH_TOO_MANY_REQUESTS
Search engine indicates that there are too many requests going on (similar to tmpfail).SERVICE_NOT_AVAILABLE
Retried because at this point in time there is no service available to dispatch to.UNKNOWN
The reason why it has been retried is unknown.VIEWS_NO_ACTIVE_PARTITION
There is no active partition on that node, cannot serve view.VIEWS_TEMPORARY_FAILURE
If the view engine indicates a temporary issue.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowsNonIdempotentRetry()
static RetryReason
valueOf(String name)
Returns the enum constant of this type with the specified name.static RetryReason[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNKNOWN
public static final RetryReason UNKNOWN
The reason why it has been retried is unknown.
-
ENDPOINT_NOT_AVAILABLE
public static final RetryReason ENDPOINT_NOT_AVAILABLE
Retried because at the point in time there was no endpoint available to dispatch to.
-
ENDPOINT_TEMPORARILY_NOT_AVAILABLE
@Deprecated public static final RetryReason ENDPOINT_TEMPORARILY_NOT_AVAILABLE
Deprecated.Retried because no endpoint available, but a new one being opened in parallel.This enum variant is deprecated because the SDK now uses a different strategy. Look for
ENDPOINT_NOT_AVAILABLE
only.
-
ENDPOINT_CIRCUIT_OPEN
public static final RetryReason ENDPOINT_CIRCUIT_OPEN
Short circuits the endpoint write because the circuit breaker is open at the moment.
-
SERVICE_NOT_AVAILABLE
public static final RetryReason SERVICE_NOT_AVAILABLE
Retried because at this point in time there is no service available to dispatch to.
-
NODE_NOT_AVAILABLE
public static final RetryReason NODE_NOT_AVAILABLE
Retried because at this point in time there is no node available to dispatch to.
-
KV_NOT_MY_VBUCKET
public static final RetryReason KV_NOT_MY_VBUCKET
A KV "not my vbucket" response has been received.
-
KV_COLLECTION_OUTDATED
public static final RetryReason KV_COLLECTION_OUTDATED
The collection identifier for the KV service has been outdated.
-
KV_ERROR_MAP_INDICATED
public static final RetryReason KV_ERROR_MAP_INDICATED
The KV error map indicated a retry action on an unknown response code.
-
KV_LOCKED
public static final RetryReason KV_LOCKED
Server response indicates a locked document.
-
KV_TEMPORARY_FAILURE
public static final RetryReason KV_TEMPORARY_FAILURE
Server response indicates a temporary failure.
-
KV_SYNC_WRITE_IN_PROGRESS
public static final RetryReason KV_SYNC_WRITE_IN_PROGRESS
Server response indicates a sync write in progress.
-
KV_SYNC_WRITE_RE_COMMIT_IN_PROGRESS
public static final RetryReason KV_SYNC_WRITE_RE_COMMIT_IN_PROGRESS
Server response a sync write re-commit in progress.
-
NOT_PIPELINED_REQUEST_IN_FLIGHT
public static final RetryReason NOT_PIPELINED_REQUEST_IN_FLIGHT
The request has been dispatched into a non-pipelined handler and a request is currently in-flight so it cannot be dispatched right now onto the same socket.
-
ENDPOINT_NOT_WRITABLE
public static final RetryReason ENDPOINT_NOT_WRITABLE
The endpoint is connected, but for some reason cannot be written to at the moment.
-
CHANNEL_CLOSED_WHILE_IN_FLIGHT
public static final RetryReason CHANNEL_CLOSED_WHILE_IN_FLIGHT
The underlying channel on the endpoint closed while this operation was still in-flight and we do not have a response yet.
-
BUCKET_NOT_AVAILABLE
public static final RetryReason BUCKET_NOT_AVAILABLE
If the bucket is not available, for example if it is currently in the process of being opened.
-
BUCKET_OPEN_IN_PROGRESS
public static final RetryReason BUCKET_OPEN_IN_PROGRESS
If a concurrent bucket open is in progress.
-
GLOBAL_CONFIG_LOAD_IN_PROGRESS
public static final RetryReason GLOBAL_CONFIG_LOAD_IN_PROGRESS
If a concurrent global config load is in progress.
-
COLLECTION_MAP_REFRESH_IN_PROGRESS
public static final RetryReason COLLECTION_MAP_REFRESH_IN_PROGRESS
Collection map refresh is in progress.
-
VIEWS_TEMPORARY_FAILURE
public static final RetryReason VIEWS_TEMPORARY_FAILURE
If the view engine indicates a temporary issue.
-
VIEWS_NO_ACTIVE_PARTITION
public static final RetryReason VIEWS_NO_ACTIVE_PARTITION
There is no active partition on that node, cannot serve view. This happens during a rebalance.
-
SEARCH_TOO_MANY_REQUESTS
public static final RetryReason SEARCH_TOO_MANY_REQUESTS
Search engine indicates that there are too many requests going on (similar to tmpfail).
-
QUERY_PREPARED_STATEMENT_FAILURE
public static final RetryReason QUERY_PREPARED_STATEMENT_FAILURE
A prepared statement failure that can be retried.
-
QUERY_INDEX_NOT_FOUND
public static final RetryReason QUERY_INDEX_NOT_FOUND
A query index that is temporarily not found.
-
ANALYTICS_TEMPORARY_FAILURE
public static final RetryReason ANALYTICS_TEMPORARY_FAILURE
The analytics service reports temporary failure.
-
COLLECTION_NOT_FOUND
public static final RetryReason COLLECTION_NOT_FOUND
If a collection is requested but not found in the collection map.
-
QUERY_TRANSACTION_BUFFER_FULL
public static final RetryReason QUERY_TRANSACTION_BUFFER_FULL
The query service has a buffer of statements per-transaction, which is full.
-
QUERY_ERROR_RETRYABLE
public static final RetryReason QUERY_ERROR_RETRYABLE
Server indicated that the query failed, but it is retryable.
-
-
Method Detail
-
values
public static RetryReason[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RetryReason c : RetryReason.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RetryReason valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
allowsNonIdempotentRetry
public boolean allowsNonIdempotentRetry()
-
-