CancellationReason (Couchbase JVM Core IO 2.0.6 API)

java.lang.Object
- com.couchbase.client.core.msg.CancellationReason

```
public class CancellationReason
extends Object
```
Describes the reason why a Request has been cancelled.

Since:

2.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static CancellationReason`	`CANCELLED_VIA_CONTEXT` The user or some other code proactively cancelled the request by cancelling it through its attached context.
`static CancellationReason`	`OTHER` For a different reason.
`static CancellationReason`	`SHUTDOWN` The SDK has been shut down already when this request is dispatched.
`static CancellationReason`	`STOPPED_LISTENING` The downstream consumer stopped listening for a result and therefore any further processing is a waste of resources.
`static CancellationReason`	`TIMEOUT` The request ran into a timeout and is therefore cancelled before it got a chance to complete.
`static CancellationReason`	`TOO_MANY_REQUESTS_IN_RETRY` If too many outstanding requests are waiting to be completed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`identifier()` Returns the identifier for this reason.
`Object`	`innerReason()` If applicable, returns an inner reason for the cancellation for additional context.
`static CancellationReason`	`noMoreRetries(RetryReason retryReason)` This cancellation reason indicates that no more retries were allowed based on the retry strategy.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - STOPPED_LISTENING
```
public static final CancellationReason STOPPED_LISTENING
```
    The downstream consumer stopped listening for a result and therefore any further processing is a waste of resources.
  - TIMEOUT
```
public static final CancellationReason TIMEOUT
```
    The request ran into a timeout and is therefore cancelled before it got a chance to complete.
  - CANCELLED_VIA_CONTEXT
```
public static final CancellationReason CANCELLED_VIA_CONTEXT
```
    The user or some other code proactively cancelled the request by cancelling it through its attached context.
  - SHUTDOWN
```
public static final CancellationReason SHUTDOWN
```
    The SDK has been shut down already when this request is dispatched.
  - OTHER
```
public static final CancellationReason OTHER
```
    For a different reason. Make sure to emit an event so that debugging provides further context.
  - TOO_MANY_REQUESTS_IN_RETRY
```
public static final CancellationReason TOO_MANY_REQUESTS_IN_RETRY
```
    If too many outstanding requests are waiting to be completed. This is the SDK backpressure signal.
- Method Detail
  - noMoreRetries
```
public static CancellationReason noMoreRetries(RetryReason retryReason)
```
    This cancellation reason indicates that no more retries were allowed based on the retry strategy.
    
    Parameters:
    
    retryReason - the retry reason why it got sent into retry.
    
    Returns:
    
    the cancellation reason instance.
  - innerReason
```
public Object innerReason()
```
    If applicable, returns an inner reason for the cancellation for additional context.
  - identifier
```
public String identifier()
```
    Returns the identifier for this reason.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CancellationReason

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STOPPED_LISTENING

TIMEOUT

CANCELLED_VIA_CONTEXT

SHUTDOWN

OTHER

TOO_MANY_REQUESTS_IN_RETRY

Method Detail

noMoreRetries

innerReason

identifier

toString

equals

hashCode