CouchbaseRequest (Couchbase JVM Core IO 1.5.0 API)

All Superinterfaces:

CouchbaseMessage

All Known Subinterfaces:

AnalyticsRequest, BinaryRequest, BinaryStoreRequest, BinarySubdocMultiLookupRequest, BinarySubdocMultiMutationRequest, BinarySubdocMutationRequest, BinarySubdocRequest, ClusterRequest, ConfigRequest, InternalRequest, PrelocatedRequest, QueryRequest, SearchRequest, ViewRequest

All Known Implementing Classes:

AbstractCouchbaseRequest, AbstractKeyValueRequest, AbstractSubdocMutationRequest, AbstractSubdocRequest, AddNodeRequest, AddServiceRequest, AnalyticsHandler.KeepAliveRequest, AppendRequest, BucketConfigRequest, BucketsConfigRequest, BucketStreamingRequest, CloseBucketRequest, ClusterConfigRequest, CounterRequest, DisconnectRequest, FlushRequest, GenericAnalyticsRequest, GenericQueryRequest, GetAllMutationTokensRequest, GetBucketConfigRequest, GetClusterConfigRequest, GetConfigProviderRequest, GetDesignDocumentRequest, GetDesignDocumentsRequest, GetRequest, GetSearchIndexRequest, GetUsersRequest, HealthCheckRequest, InsertBucketRequest, InsertRequest, KeyValueHandler.KeepAliveRequest, ObserveRequest, ObserveSeqnoRequest, OpenBucketRequest, PrependRequest, QueryHandler.KeepAliveRequest, QueryHandlerV2.KeepAliveRequest, RawAnalyticsRequest, RawQueryRequest, RemoveBucketRequest, RemoveDesignDocumentRequest, RemoveNodeRequest, RemoveRequest, RemoveSearchIndexRequest, RemoveServiceRequest, RemoveUserRequest, ReplaceRequest, ReplicaGetRequest, RestApiRequest, SearchHandler.KeepAliveRequest, SearchQueryRequest, SeedNodesRequest, SignalConfigReload, SignalFlush, StatRequest, SubArrayRequest, SubCounterRequest, SubDeleteRequest, SubDictAddRequest, SubDictUpsertRequest, SubExistRequest, SubGetCountRequest, SubGetRequest, SubMultiLookupRequest, SubMultiMutationRequest, SubReplaceRequest, TouchRequest, UnlockRequest, UpdateBucketRequest, UpsertDesignDocumentRequest, UpsertRequest, UpsertSearchIndexRequest, UpsertUserRequest, ViewHandler.KeepAliveRequest, ViewQueryRequest
```
public interface CouchbaseRequest
extends CouchbaseMessage
```
High-Level marker interface for all CouchbaseRequests.

Since:

1.0

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`bucket()` The associated bucket name for this request.
`String`	`dispatchHostname()`
`void`	`dispatchHostname(String hostname)`
`int`	`incrementRetryCount()` Returns the old retry count and increments it by one.
`boolean`	`isActive()` Checks if the request is unsubscribed on a timeout
`long`	`maxRetryDuration()` Returns the maximum retry duration for the request.
`void`	`maxRetryDuration(long duration)` Sets the maximum retry duration for the request.
`rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse>`	`observable()` Get the underlying `Observable`.
`String`	`password()` The password associated with the bucket/ user
`long`	`retryAfter()` Gets the initial retry after time for the request.
`void`	`retryAfter(long after)` Sets the initial retry after time for the request.
`int`	`retryCount()` Returns the current retry count.
`Delay`	`retryDelay()` Returns the retry delay config
`void`	`retryDelay(Delay delay)` Sets the retry delay config
`void`	`subscriber(rx.Subscriber subscriber)` Optionally add subscriber to check for the timeouts
`String`	`username()` User authorized for bucket access

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage
creationTime

- Method Detail
  - observable
```
rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse> observable()
```
    Get the underlying Observable.
    
    Returns:
    
    the observable which will complete the response.
  - bucket
```
String bucket()
```
    The associated bucket name for this request.
    
    Returns:
    
    the bucket name.
  - username
```
String username()
```
    User authorized for bucket access
  - password
```
String password()
```
    The password associated with the bucket/ user
    
    Returns:
    
    the password.
  - incrementRetryCount
```
int incrementRetryCount()
```
    Returns the old retry count and increments it by one.
    
    Returns:
    
    the old retryCount.
  - retryCount
```
int retryCount()
```
    Returns the current retry count.
    
    Returns:
    
    the current retry count.
  - retryAfter
```
void retryAfter(long after)
```
    Sets the initial retry after time for the request.
    
    Parameters:
    
    after -
  - retryAfter
```
long retryAfter()
```
    Gets the initial retry after time for the request.
  - maxRetryDuration
```
void maxRetryDuration(long duration)
```
    Sets the maximum retry duration for the request.
    
    Parameters:
    
    duration -
  - maxRetryDuration
```
long maxRetryDuration()
```
    Returns the maximum retry duration for the request.
    
    Returns:
    
    duration
  - retryDelay
```
void retryDelay(Delay delay)
```
    Sets the retry delay config
    
    Parameters:
    
    delay -
  - retryDelay
```
Delay retryDelay()
```
    Returns the retry delay config
    
    Returns:
    
    delay
  - isActive
```
@InterfaceAudience.Private
 @InterfaceStability.Uncommitted
boolean isActive()
```
    Checks if the request is unsubscribed on a timeout
    
    Returns:
    
    false if timed out, else true
  - subscriber
```
@InterfaceAudience.Private
 @InterfaceStability.Uncommitted
void subscriber(rx.Subscriber subscriber)
```
    Optionally add subscriber to check for the timeouts
  - dispatchHostname
```
String dispatchHostname()
```
  - dispatchHostname
```
void dispatchHostname(String hostname)
```

Interface CouchbaseRequest

Method Summary

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage

Method Detail

observable

bucket

username

password

incrementRetryCount

retryCount

retryAfter

retryAfter

maxRetryDuration

maxRetryDuration

retryDelay

retryDelay

isActive

subscriber

dispatchHostname

dispatchHostname