CouchbaseAsyncBucket (Couchbase Java SDK)

java.lang.Object
- com.couchbase.client.java.CouchbaseAsyncBucket

All Implemented Interfaces:: AsyncBucket

public class CouchbaseAsyncBucket
extends Object
implements AsyncBucket

Field Summary

Fields
Modifier and Type	Field and Description
`static BinaryTranscoder`	`BINARY_TRANSCODER`
`static String`	`CURRENT_BUCKET_IDENTIFIER`
`static JsonArrayTranscoder`	`JSON_ARRAY_TRANSCODER`
`static JsonBooleanTranscoder`	`JSON_BOOLEAN_TRANSCODER`
`static JsonDoubleTranscoder`	`JSON_DOUBLE_TRANSCODER`
`static JsonLongTranscoder`	`JSON_LONG_TRANSCODER`
`static JsonTranscoder`	`JSON_OBJECT_TRANSCODER`
`static JsonStringTranscoder`	`JSON_STRING_TRANSCODER`
`static LegacyTranscoder`	`LEGACY_TRANSCODER`
`static RawJsonTranscoder`	`RAW_JSON_TRANSCODER`
`static SerializableTranscoder`	`SERIALIZABLE_TRANSCODER`
`static StringTranscoder`	`STRING_TRANSCODER`

Constructor Summary

Constructors
Constructor and Description
`CouchbaseAsyncBucket(ClusterFacade core, CouchbaseEnvironment environment, String name, String password, List<Transcoder<? extends Document,?>> customTranscoders)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<D extends Document<?>> Observable<D>`	`append(D document)` Append a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`append(D document, PersistTo persistTo)` Append a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`append(D document, PersistTo persistTo, ReplicateTo replicateTo)` Append a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`append(D document, ReplicateTo replicateTo)` Append a `Document`s content to an existing one.
`Observable<AsyncBucketManager>`	`bucketManager()` Provides access to the `AsyncBucketManager` for administrative access.
`Observable<Boolean>`	`close()` Closes the `AsyncBucket`.
`Observable<ClusterFacade>`	`core()` Returns the underlying “core-io” library through its `ClusterFacade`.
`Observable<JsonLongDocument>`	`counter(String id, long delta)` Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, int expiry)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, int expiry, PersistTo persistTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, int expiry, PersistTo persistTo, ReplicateTo replicateTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, int expiry, ReplicateTo replicateTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, PersistTo persistTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, PersistTo persistTo, ReplicateTo replicateTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, long initial, ReplicateTo replicateTo)` Increment or decrement a counter with the given value and a initial value if it does not exist.
`Observable<JsonLongDocument>`	`counter(String id, long delta, PersistTo persistTo)` Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
`Observable<JsonLongDocument>`	`counter(String id, long delta, PersistTo persistTo, ReplicateTo replicateTo)` Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
`Observable<JsonLongDocument>`	`counter(String id, long delta, ReplicateTo replicateTo)` Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
`CouchbaseEnvironment`	`environment()` The `CouchbaseEnvironment` used.
`<D extends Document<?>> Observable<Boolean>`	`exists(D document)` Check whether a document with the given ID does exist in the bucket.
`Observable<Boolean>`	`exists(String id)` Check whether a document with the given ID does exist in the bucket.
`<D extends Document<?>> Observable<D>`	`get(D document)` Retrieves any type of `Document` by its unique ID.
`Observable<JsonDocument>`	`get(String id)` Retrieves a `JsonDocument` by its unique ID.
`<D extends Document<?>> Observable<D>`	`get(String id, Class<D> target)` Retrieves any type of `Document` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getAndLock(D document, int lockTime)` Retrieve and lock a `Document` by its unique ID.
`Observable<JsonDocument>`	`getAndLock(String id, int lockTime)` Retrieve and lock a `JsonDocument` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getAndLock(String id, int lockTime, Class<D> target)` Retrieve and lock a `Document` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getAndTouch(D document)` Retrieve and touch a `Document` by its unique ID.
`Observable<JsonDocument>`	`getAndTouch(String id, int expiry)` Retrieve and touch a `JsonDocument` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getAndTouch(String id, int expiry, Class<D> target)` Retrieve and touch a `Document` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getFromReplica(D document, ReplicaMode type)` Retrieves one or more, possibly stale, representations of a `Document` by its unique ID.
`Observable<JsonDocument>`	`getFromReplica(String id, ReplicaMode type)` Retrieves one or more, possibly stale, representations of a `JsonDocument` by its unique ID.
`<D extends Document<?>> Observable<D>`	`getFromReplica(String id, ReplicaMode type, Class<D> target)` Retrieves one or more, possibly stale, representations of a `Document` by its unique ID.
`<D extends Document<?>> Observable<D>`	`insert(D document)` Insert a `Document` if it does not exist already.
`<D extends Document<?>> Observable<D>`	`insert(D document, PersistTo persistTo)` Insert a `Document` if it does not exist already and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`insert(D document, PersistTo persistTo, ReplicateTo replicateTo)` Insert a `Document` if it does not exist already and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`insert(D document, ReplicateTo replicateTo)` Insert a `Document` if it does not exist already and watch for durability constraints.
`Observable<Integer>`	`invalidateQueryCache()` Invalidates and clears the internal query cache.
`boolean`	`isClosed()` Returns true if this bucket is already closed, false if it is still open.
`<E> Observable<Boolean>`	`listAppend(String docId, E element)` Push an element to tail of CouchbaseList
`<E> Observable<Boolean>`	`listAppend(String docId, E element, MutationOptionBuilder mutationOptionBuilder)` Push an element to tail of CouchbaseList with additional mutation options provided by `MutationOptionBuilder`
`<E> Observable<E>`	`listGet(String docId, int index, Class<E> elementType)` Get element at an index in the CouchbaseList
`<E> Observable<Boolean>`	`listPrepend(String docId, E element)` Shift list head to element in CouchbaseList
`<E> Observable<Boolean>`	`listPrepend(String docId, E element, MutationOptionBuilder mutationOptionBuilder)` Shift list head to element in CouchbaseList with additional mutation options provided by `MutationOptionBuilder`
`Observable<Boolean>`	`listRemove(String docId, int index)` Remove an element from an index in CouchbaseList
`Observable<Boolean>`	`listRemove(String docId, int index, MutationOptionBuilder mutationOptionBuilder)` Remove an element from an index in CouchbaseList with additional mutation options provided by `MutationOptionBuilder`
`<E> Observable<Boolean>`	`listSet(String docId, int index, E element)` Add an element at an index in CouchbaseList
`<E> Observable<Boolean>`	`listSet(String docId, int index, E element, MutationOptionBuilder mutationOptionBuilder)` Add an element at an index in CouchbaseList with additional mutation options provided by `MutationOptionBuilder`.
`Observable<Integer>`	`listSize(String docId)` Returns the number of elements in CouchbaseList
`AsyncLookupInBuilder`	`lookupIn(String docId)` Prepare a sub-document lookup through a `builder API`.
`<V> Observable<Boolean>`	`mapAdd(String docId, String key, V value)` Add a key value pair into CouchbaseMap
`<V> Observable<Boolean>`	`mapAdd(String docId, String key, V value, MutationOptionBuilder mutationOptionBuilder)` Add a key value pair into CouchbaseMap with additional mutation options provided by `MutationOptionBuilder`
`<V> Observable<V>`	`mapGet(String docId, String key, Class<V> valueType)` Get value of a key in the CouchbaseMap
`Observable<Boolean>`	`mapRemove(String docId, String key)` Remove a key value pair from CouchbaseMap
`Observable<Boolean>`	`mapRemove(String docId, String key, MutationOptionBuilder mutationOptionBuilder)` Remove a key value pair from CouchbaseMap with additional mutation options provided by `MutationOptionBuilder`
`Observable<Integer>`	`mapSize(String docId)` Returns the number key value pairs in CouchbaseMap
`AsyncMutateInBuilder`	`mutateIn(String docId)` Prepare a sub-document mutation through a `builder API`.
`protected N1qlQueryExecutor`	`n1qlQueryExecutor()` Returns the underlying `N1qlQueryExecutor` used to perform N1QL queries.
`String`	`name()` The name of the `Bucket`.
`<D extends Document<?>> Observable<D>`	`prepend(D document)` Prepend a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`prepend(D document, PersistTo persistTo)` Prepend a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`prepend(D document, PersistTo persistTo, ReplicateTo replicateTo)` Prepend a `Document`s content to an existing one.
`<D extends Document<?>> Observable<D>`	`prepend(D document, ReplicateTo replicateTo)` Prepend a `Document`s content to an existing one.
`Observable<AsyncN1qlQueryResult>`	`query(N1qlQuery query)` Queries a N1QL secondary index.
`Observable<AsyncSearchQueryResult>`	`query(SearchQuery query)` Experimental: Queries a Full-Text Index
`Observable<AsyncSpatialViewResult>`	`query(SpatialViewQuery query)` Queries a Couchbase Server Spatial `View`.
`Observable<AsyncN1qlQueryResult>`	`query(Statement statement)` Queries a N1QL secondary index with a simple `Statement`.
`Observable<AsyncViewResult>`	`query(ViewQuery query)` Queries a Couchbase Server `View`.
`<E> Observable<E>`	`queuePop(String docId, Class<E> elementType)` Removes the first element from CouchbaseQueue
`<E> Observable<E>`	`queuePop(String docId, Class<E> elementType, MutationOptionBuilder mutationOptionBuilder)` Removes the first element from CouchbaseQueue with additional mutation options provided by `MutationOptionBuilder`
`<E> Observable<Boolean>`	`queuePush(String docId, E element)` Add an element into CouchbaseQueue
`<E> Observable<Boolean>`	`queuePush(String docId, E element, MutationOptionBuilder mutationOptionBuilder)` Add an element into CouchbaseQueue with additional mutation options provided by `MutationOptionBuilder`
`Observable<Integer>`	`queueSize(String docId)` Returns the number of elements in CouchbaseQueue
`<D extends Document<?>> Observable<D>`	`remove(D document)` Removes a `Document` from the Server.
`<D extends Document<?>> Observable<D>`	`remove(D document, PersistTo persistTo)` Removes a `Document` from the Server and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`remove(D document, PersistTo persistTo, ReplicateTo replicateTo)` Removes a `Document` from the Server and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`remove(D document, ReplicateTo replicateTo)` Removes a `Document` from the Server and apply a durability requirement.
`Observable<JsonDocument>`	`remove(String id)` Removes a `Document` from the Server identified by its ID.
`<D extends Document<?>> Observable<D>`	`remove(String id, Class<D> target)` Removes a `Document` from the Server identified by its ID.
`Observable<JsonDocument>`	`remove(String id, PersistTo persistTo)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`remove(String id, PersistTo persistTo, Class<D> target)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`Observable<JsonDocument>`	`remove(String id, PersistTo persistTo, ReplicateTo replicateTo)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`remove(String id, PersistTo persistTo, ReplicateTo replicateTo, Class<D> target)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`Observable<JsonDocument>`	`remove(String id, ReplicateTo replicateTo)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`remove(String id, ReplicateTo replicateTo, Class<D> target)` Removes a `Document` from the Server by its ID and apply a durability requirement.
`<D extends Document<?>> Observable<D>`	`replace(D document)` Replace a `Document` if it does already exist.
`<D extends Document<?>> Observable<D>`	`replace(D document, PersistTo persistTo)` Replace a `Document` if it does exist and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`replace(D document, PersistTo persistTo, ReplicateTo replicateTo)` Replace a `Document` if it does exist and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`replace(D document, ReplicateTo replicateTo)` Replace a `Document` if it does exist and watch for durability constraints.
`Observable<AsyncRepository>`	`repository()` The `Repository` provides access to full object document mapping (ODM) capabilities.
`<E> Observable<Boolean>`	`setAdd(String docId, E element)` Add an element into CouchbaseSet
`<E> Observable<Boolean>`	`setAdd(String docId, E element, MutationOptionBuilder mutationOptionBuilder)` Add an element into CouchbaseSet with additional mutation options provided by `MutationOptionBuilder`
`<E> Observable<Boolean>`	`setContains(String docId, E element)` Check if an element exists in CouchbaseSet
`<E> Observable<E>`	`setRemove(String docId, E element)` Removes an element from CouchbaseSet
`<E> Observable<E>`	`setRemove(String docId, E element, MutationOptionBuilder mutationOptionBuilder)` Removes an element from CouchbaseSet with additional mutation options provided by `MutationOptionBuilder`
`Observable<Integer>`	`setSize(String docId)` Returns the number of elements in CouchbaseSet
`FragmentTranscoder`	`subdocumentTranscoder()` Returns the transcoder to be used for individual JSON fragments used and returned by the subdocument API.
`String`	`toString()`
`<D extends Document<?>> Observable<Boolean>`	`touch(D document)` Renews the expiration time of a `Document`.
`Observable<Boolean>`	`touch(String id, int expiry)` Renews the expiration time of a `Document`.
`<D extends Document<?>> Observable<Boolean>`	`unlock(D document)` Unlocks a write-locked `Document`.
`Observable<Boolean>`	`unlock(String id, long cas)` Unlocks a write-locked `Document`.
`<D extends Document<?>> Observable<D>`	`upsert(D document)` Insert or overwrite a `Document`.
`<D extends Document<?>> Observable<D>`	`upsert(D document, PersistTo persistTo)` Insert or overwrite a `Document` and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`upsert(D document, PersistTo persistTo, ReplicateTo replicateTo)` Insert or overwrite a `Document` and watch for durability constraints.
`<D extends Document<?>> Observable<D>`	`upsert(D document, ReplicateTo replicateTo)` Insert or overwrite a `Document` and watch for durability constraints.

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

- Field Detail
  - CURRENT_BUCKET_IDENTIFIER
```
public static final String CURRENT_BUCKET_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - JSON_OBJECT_TRANSCODER
```
public static final JsonTranscoder JSON_OBJECT_TRANSCODER
```
  - JSON_ARRAY_TRANSCODER
```
public static final JsonArrayTranscoder JSON_ARRAY_TRANSCODER
```
  - JSON_BOOLEAN_TRANSCODER
```
public static final JsonBooleanTranscoder JSON_BOOLEAN_TRANSCODER
```
  - JSON_DOUBLE_TRANSCODER
```
public static final JsonDoubleTranscoder JSON_DOUBLE_TRANSCODER
```
  - JSON_LONG_TRANSCODER
```
public static final JsonLongTranscoder JSON_LONG_TRANSCODER
```
  - JSON_STRING_TRANSCODER
```
public static final JsonStringTranscoder JSON_STRING_TRANSCODER
```
  - RAW_JSON_TRANSCODER
```
public static final RawJsonTranscoder RAW_JSON_TRANSCODER
```
  - LEGACY_TRANSCODER
```
public static final LegacyTranscoder LEGACY_TRANSCODER
```
  - BINARY_TRANSCODER
```
public static final BinaryTranscoder BINARY_TRANSCODER
```
  - STRING_TRANSCODER
```
public static final StringTranscoder STRING_TRANSCODER
```
  - SERIALIZABLE_TRANSCODER
```
public static final SerializableTranscoder SERIALIZABLE_TRANSCODER
```
- Constructor Detail
  - CouchbaseAsyncBucket
```
public CouchbaseAsyncBucket(ClusterFacade core,
                            CouchbaseEnvironment environment,
                            String name,
                            String password,
                            List<Transcoder<? extends Document,?>> customTranscoders)
```
- Method Detail
  - name
```
public String name()
```
    Description copied from interface: AsyncBucket
    
    The name of the Bucket.
    
    Specified by:
    
    name in interface AsyncBucket
    
    Returns:
    
    the name of the bucket.
  - core
```
public Observable<ClusterFacade> core()
```
    Description copied from interface: AsyncBucket
    
    Returns the underlying “core-io” library through its ClusterFacade.
    Handle with care, with great power comes great responsibility. All additional checks which are normally performed by this library are skipped.
    
    Specified by:
    
    core in interface AsyncBucket
    
    Returns:
    
    the underlying ClusterFacade from the “core-io” package.
  - subdocumentTranscoder
```
public FragmentTranscoder subdocumentTranscoder()
```
    Description copied from interface: AsyncBucket
    
    Returns the transcoder to be used for individual JSON fragments used and returned by the subdocument API.
    
    Specified by:
    
    subdocumentTranscoder in interface AsyncBucket
    
    Returns:
    
    the FragmentTranscoder to be used within the subdocument API.
    
    See Also:
    
    AsyncBucket.lookupIn(String), AsyncBucket.mutateIn(String)
  - n1qlQueryExecutor
```
protected N1qlQueryExecutor n1qlQueryExecutor()
```
    Returns the underlying N1qlQueryExecutor used to perform N1QL queries.
    Handle with care since all additional checks that are normally performed by this library may be skipped (hence the protected visibility).
  - environment
```
public CouchbaseEnvironment environment()
```
    Description copied from interface: AsyncBucket
    
    The CouchbaseEnvironment used.
    
    Specified by:
    
    environment in interface AsyncBucket
    
    Returns:
    
    the CouchbaseEnvironment.
  - repository
```
public Observable<AsyncRepository> repository()
```
    Description copied from interface: AsyncBucket
    
    The Repository provides access to full object document mapping (ODM) capabilities.
    It allows you to work with POJO entities only and use annotations to customize the behaviour and mapping characteristics.
    
    Specified by:
    
    repository in interface AsyncBucket
    
    Returns:
    
    the repository for ODM capabilities.
  - get
```
public Observable<JsonDocument> get(String id)
```
    Description copied from interface: AsyncBucket
    Retrieves a JsonDocument by its unique ID.
    If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    get in interface AsyncBucket
    
    Parameters:
    
    id - the unique ID of the document.
    
    Returns:
    
    an Observable eventually containing the found JsonDocument.
  - get
```
public <D extends Document<?>> Observable<D> get(D document)
```
    Description copied from interface: AsyncBucket
    Retrieves any type of Document by its unique ID.
    The document ID is taken out of the Document provided, as well as the target type to return. Note that not the same document is returned, but rather a new one of the same type with the freshly loaded properties.
    If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    get in interface AsyncBucket
    
    Parameters:
    
    document - the source document from which the ID is taken and the type is inferred.
    
    Returns:
    
    an Observable eventually containing the found Document.
  - get
```
public <D extends Document<?>> Observable<D> get(String id,
                                                 Class<D> target)
```
    Description copied from interface: AsyncBucket
    Retrieves any type of Document by its unique ID.
    This method differs from AsyncBucket.get(String) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
    If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    get in interface AsyncBucket
    
    Parameters:
    
    id - the unique ID of the document.
    
    target - the target document type to use.
    
    Returns:
    
    an Observable eventually containing the found Document.
  - exists
```
public Observable<Boolean> exists(String id)
```
    Description copied from interface: AsyncBucket
    Check whether a document with the given ID does exist in the bucket.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    exists in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    Returns:
    
    true if it exists, false otherwise.
  - exists
```
public <D extends Document<?>> Observable<Boolean> exists(D document)
```
    Description copied from interface: AsyncBucket
    Check whether a document with the given ID does exist in the bucket.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    exists in interface AsyncBucket
    
    Parameters:
    
    document - the document where the ID is extracted from.
    
    Returns:
    
    true if it exists, false otherwise.
  - getAndLock
```
public Observable<JsonDocument> getAndLock(String id,
                                           int lockTime)
```
    Description copied from interface: AsyncBucket
    Retrieve and lock a JsonDocument by its unique ID.
    If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(String), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
    Detecting an already locked document is done by checking for TemporaryLockFailureException. Note that this exception can also be raised in other conditions, always when the error is transient and retrying may help.
    The returned Observable can error under the following conditions:
    - In case of transient error, most probably because key is already locked: TemporaryLockFailureException
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    getAndLock in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    lockTime - the time to write lock the document (max. 30 seconds).
    
    Returns:
    
    an Observable eventually containing the found JsonDocument.
  - getAndLock
```
public <D extends Document<?>> Observable<D> getAndLock(D document,
                                                        int lockTime)
```
    Description copied from interface: AsyncBucket
    Retrieve and lock a Document by its unique ID.
    If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(Document), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
    Detecting an already locked document is done by checking for TemporaryLockFailureException. Note that this exception can also be raised in other conditions, always when the error is transient and retrying may help.
    The returned Observable can error under the following conditions:
    - In case of transient error, most probably because key is already locked: TemporaryLockFailureException
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    getAndLock in interface AsyncBucket
    
    Parameters:
    
    document - the source document from which the ID is taken and the type is inferred.
    
    lockTime - the time to write lock the document (max. 30 seconds).
    
    Returns:
    
    an Observable eventually containing the found Document.
  - getAndLock
```
public <D extends Document<?>> Observable<D> getAndLock(String id,
                                                        int lockTime,
                                                        Class<D> target)
```
    Description copied from interface: AsyncBucket
    
    Retrieve and lock a Document by its unique ID.
    This method differs from AsyncBucket.getAndLock(String, int) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
    If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(String), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
    Detecting an already locked document is done by checking for TemporaryLockFailureException. Note that this exception can also be raised in other conditions, always when the error is transient and retrying may help.
    The returned Observable can error under the following conditions: - In case of transient error, most probably because key is already locked: TemporaryLockFailureException - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    getAndLock in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    lockTime - the time to write lock the document (max. 30 seconds).
    
    target - the target document type to use.
    
    Returns:
    
    an Observable eventually containing the found Document.
  - getAndTouch
```
public Observable<JsonDocument> getAndTouch(String id,
                                            int expiry)
```
    Description copied from interface: AsyncBucket
    Retrieve and touch a JsonDocument by its unique ID.
    If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(String), but in addition it touches the document, which will reset its configured expiration time to the value provided.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    getAndTouch in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    expiry - the new expiration time for the document.
    
    Returns:
    
    an Observable eventually containing the found JsonDocument.
  - getAndTouch
```
public <D extends Document<?>> Observable<D> getAndTouch(D document)
```
    Description copied from interface: AsyncBucket
    Retrieve and touch a Document by its unique ID.
    If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(Document), but in addition it touches the document, which will reset its configured expiration time set on the given document itself.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    getAndTouch in interface AsyncBucket
    
    Parameters:
    
    document - the source document from which the ID and expiry is taken and the type is inferred.
    
    Returns:
    
    an Observable eventually containing the found Document.
  - getAndTouch
```
public <D extends Document<?>> Observable<D> getAndTouch(String id,
                                                         int expiry,
                                                         Class<D> target)
```
    Description copied from interface: AsyncBucket
    Retrieve and touch a Document by its unique ID.
    This method differs from AsyncBucket.getAndTouch(String, int) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
    If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
    This method works similar to AsyncBucket.get(String, Class), but in addition it touches the document, which will reset its configured expiration time to the value provided.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    getAndTouch in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    expiry - the new expiration time for the document.
    
    target - the target document type to use.
    
    Returns:
    
    an Observable eventually containing the found Document.
  - getFromReplica
```
public Observable<JsonDocument> getFromReplica(String id,
                                               ReplicaMode type)
```
    Description copied from interface: AsyncBucket
    
    Retrieves one or more, possibly stale, representations of a JsonDocument by its unique ID.
    Depending on the ReplicaMode selected, there can be none to four JsonDocument be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
    If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
    Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
    Note that the returning JsonDocument responses can come in any order.
    Because this method is considered to be a “last resort” call against the database if a regular get didn’t succeed, all errors are swallowed (but logged) and the Observable will return all successful responses.
    
    Specified by:
    
    getFromReplica in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    type - the ReplicaMode to select.
    
    Returns:
    
    an Observable eventually containing zero to N JsonDocuments.
  - getFromReplica
```
public <D extends Document<?>> Observable<D> getFromReplica(D document,
                                                            ReplicaMode type)
```
    Description copied from interface: AsyncBucket
    
    Retrieves one or more, possibly stale, representations of a Document by its unique ID.
    The document ID is taken out of the Document provided, as well as the target type to return. Note that not the same document is returned, but rather a new one of the same type with the freshly loaded properties.
    Depending on the ReplicaMode selected, there can be none to four Document be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
    If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
    Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
    Note that the returning Document responses can come in any order.
    The returned Observable can error under the following conditions:
    Because this method is considered to be a “last resort” call against the database if a regular get didn’t succeed, all errors are swallowed (but logged) and the Observable will return all successful responses.
    
    Specified by:
    
    getFromReplica in interface AsyncBucket
    
    Parameters:
    
    document - the source document from which the ID is taken and the type is inferred.
    
    type - the ReplicaMode to select.
    
    Returns:
    
    an Observable eventually containing zero to N Documents.
  - getFromReplica
```
public <D extends Document<?>> Observable<D> getFromReplica(String id,
                                                            ReplicaMode type,
                                                            Class<D> target)
```
    Description copied from interface: AsyncBucket
    
    Retrieves one or more, possibly stale, representations of a Document by its unique ID.
    This method differs from AsyncBucket.getFromReplica(String, ReplicaMode) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
    Depending on the ReplicaMode selected, there can be none to four Document be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
    If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
    Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
    Note that the returning Document responses can come in any order.
    The returned Observable can error under the following conditions:
    Because this method is considered to be a “last resort” call against the database if a regular get didn’t succeed, all errors are swallowed (but logged) and the Observable will return all successful responses.
    
    Specified by:
    
    getFromReplica in interface AsyncBucket
    
    Parameters:
    
    id - id the unique ID of the document.
    
    type - the ReplicaMode to select.
    
    target - the target document type to use.
    
    Returns:
    
    an Observable eventually containing zero to N Documents.
  - insert
```
public <D extends Document<?>> Observable<D> insert(D document)
```
    Description copied from interface: AsyncBucket
    Insert a Document if it does not exist already.
    If the given Document (identified by its unique ID) already exists, the observable errors with a DocumentAlreadyExistsException. If the operation should also override the existing Document, AsyncBucket.upsert(Document) should be used instead. It will always either return a document or fail with an error.
    The returned Document contains original properties, but has the refreshed CAS value set.
    This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, AsyncBucket.insert(Document, PersistTo, ReplicateTo) should be used instead.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original insert failed because the document is already stored: DocumentAlreadyExistsException
    - The request content is too big: RequestTooBigException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    insert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to insert.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - insert
```
public <D extends Document<?>> Observable<D> insert(D document,
                                                    PersistTo persistTo,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Insert a Document if it does not exist already and watch for durability constraints.
    This method works exactly like AsyncBucket.insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original insert failed because the document is already stored: DocumentAlreadyExistsException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    insert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to insert.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - upsert
```
public <D extends Document<?>> Observable<D> upsert(D document)
```
    Description copied from interface: AsyncBucket
    Insert or overwrite a Document.
    If the given Document (identified by its unique ID) already exists, it will be overridden by the current one. The returned Document contains original properties, but has the refreshed CAS value set.
    Please note that this method will not use the Document.cas() for optimistic concurrency checks. If this behavior is needed, the AsyncBucket.replace(Document) method needs to be used.
    This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, AsyncBucket.upsert(Document, PersistTo, ReplicateTo) should be used instead.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    upsert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to upsert.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - upsert
```
public <D extends Document<?>> Observable<D> upsert(D document,
                                                    PersistTo persistTo,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Insert or overwrite a Document and watch for durability constraints.
    This method works exactly like AsyncBucket.upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    Please note that this method will not use the Document.cas() for optimistic concurrency checks. If this behavior is needed, the AsyncBucket.replace(Document, PersistTo, ReplicateTo) method needs to be used.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    upsert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to upsert.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - replace
```
public <D extends Document<?>> Observable<D> replace(D document)
```
    Description copied from interface: AsyncBucket
    Replace a Document if it does already exist.
    If the given Document (identified by its unique ID) does not exist already, the method errors with a DocumentDoesNotExistException. If the operation should also insert the Document, AsyncBucket.upsert(Document) should be used instead. It will always either return a document or fail with an error.
    The returned Document contains original properties, but has the refreshed CAS value set.
    This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, AsyncBucket.replace(Document, PersistTo, ReplicateTo) should be used instead.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original replace failed because the document does not exist: DocumentDoesNotExistException
    - The request content is too big: RequestTooBigException
    - A CAS value was set and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    replace in interface AsyncBucket
    
    Parameters:
    
    document - the Document to replace.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - replace
```
public <D extends Document<?>> Observable<D> replace(D document,
                                                     PersistTo persistTo,
                                                     ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Replace a Document if it does exist and watch for durability constraints.
    This method works exactly like AsyncBucket.replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original replace failed because the document does not exist: DocumentDoesNotExistException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - A CAS value was set and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    replace in interface AsyncBucket
    
    Parameters:
    
    document - the Document to replace.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - remove
```
public <D extends Document<?>> Observable<D> remove(D document)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - A CAS value was set on the Document and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    document - the document to remove, with the ID extracted.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public Observable<JsonDocument> remove(String id)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server identified by its ID.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(String id,
                                                    Class<D> target)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server identified by its ID.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    target - the target document type to use.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(D document,
                                                    PersistTo persistTo,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - A CAS value was set on the Document and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    document - the document to remove, with the ID extracted.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public Observable<JsonDocument> remove(String id,
                                       PersistTo persistTo,
                                       ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(String id,
                                                    PersistTo persistTo,
                                                    ReplicateTo replicateTo,
                                                    Class<D> target)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    target - the target document type to use.
    
    Returns:
    
    the document containing the ID.
  - query
```
public Observable<AsyncViewResult> query(ViewQuery query)
```
    Description copied from interface: AsyncBucket
    Queries a Couchbase Server View.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - If the design document or view is not found: ViewDoesNotExistException
    Specified by:
    
    query in interface AsyncBucket
    
    Parameters:
    
    query - the query to perform.
    
    Returns:
    
    a result containing all the found rows and additional information.
  - query
```
public Observable<AsyncSearchQueryResult> query(SearchQuery query)
```
    Description copied from interface: AsyncBucket
    Experimental: Queries a Full-Text Index
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    Specified by:
    
    query in interface AsyncBucket
    
    Parameters:
    
    query - the query builder.
    
    Returns:
    
    a query result containing the matches and additional information.
  - query
```
public Observable<AsyncSpatialViewResult> query(SpatialViewQuery query)
```
    Description copied from interface: AsyncBucket
    Queries a Couchbase Server Spatial View.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - If the design document or view is not found: ViewDoesNotExistException
    Specified by:
    
    query in interface AsyncBucket
    
    Parameters:
    
    query - the spatial query to perform.
    
    Returns:
    
    a result containing all the found rows and additional information.
  - query
```
public Observable<AsyncN1qlQueryResult> query(Statement statement)
```
    Description copied from interface: AsyncBucket
    Queries a N1QL secondary index with a simple Statement.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    Specified by:
    
    query in interface AsyncBucket
    
    Parameters:
    
    statement - the statement in a DSL form (start with a static select() import).
    
    Returns:
    
    a result containing all found rows and additional information.
  - query
```
public Observable<AsyncN1qlQueryResult> query(N1qlQuery query)
```
    Description copied from interface: AsyncBucket
    Queries a N1QL secondary index.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    Specified by:
    
    query in interface AsyncBucket
    
    Parameters:
    
    query - the full N1qlQuery.
    
    Returns:
    
    a result containing all found rows and additional information.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - If the document does not exist: DocumentDoesNotExistException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            int expiry)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    This method allows to set an expiration time for the document as well. It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    expiry - the new expiration time for the document.
    
    Returns:
    
    a Document containing the resulting value.
  - unlock
```
public Observable<Boolean> unlock(String id,
                                  long cas)
```
    Description copied from interface: AsyncBucket
    Unlocks a write-locked Document.
    The returned Observable can error under the following conditions:
    - A transient error happened, most likely the CAS value was not correct: TemporaryLockFailureException
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    unlock in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to unlock.
    
    cas - the CAS value which is mandatory to unlock it.
    
    Returns:
    
    a Boolean indicating if the unlock was successful or not.
  - unlock
```
public <D extends Document<?>> Observable<Boolean> unlock(D document)
```
    Description copied from interface: AsyncBucket
    Unlocks a write-locked Document.
    The returned Observable can error under the following conditions:
    - The document doesn’t exist: DocumentDoesNotExistException
    - A transient error happened, most likely the CAS value was not correct: TemporaryLockFailureException
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    unlock in interface AsyncBucket
    
    Parameters:
    
    document - the document where ID and CAS are extracted from.
    
    Returns:
    
    a Boolean indicating if the unlock was successful. (note that unsuccessful touch will rather raise an exception)
  - touch
```
public Observable<Boolean> touch(String id,
                                 int expiry)
```
    Description copied from interface: AsyncBucket
    Renews the expiration time of a Document.
    Compared to AsyncBucket.getAndTouch(Document), this method does not actually fetch the document from the server, but it just resets its expiration time to the given value.
    The returned Observable can error under the following conditions:
    - The document doesn’t exist: DocumentDoesNotExistException
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    touch in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    expiry - the new expiration time. 0 means no expiry.
    
    Returns:
    
    a Boolean indicating if the touch had been successful. (note that unsuccessful touch will rather raise an exception)
  - touch
```
public <D extends Document<?>> Observable<Boolean> touch(D document)
```
    Description copied from interface: AsyncBucket
    Renews the expiration time of a Document.
    Compared to AsyncBucket.getAndTouch(Document), this method does not actually fetch the document from the server, but it just resets its expiration time to the given value.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    touch in interface AsyncBucket
    
    Parameters:
    
    document - the document to extract the ID and expiry from.
    
    Returns:
    
    a copy of the document inserted.
  - append
```
public <D extends Document<?>> Observable<D> append(D document)
```
    Description copied from interface: AsyncBucket
    Append a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the appended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    append in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is appended to the existing one.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - prepend
```
public <D extends Document<?>> Observable<D> prepend(D document)
```
    Description copied from interface: AsyncBucket
    Prepend a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the prepended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    prepend in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is prepended to the existing one.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - bucketManager
```
public Observable<AsyncBucketManager> bucketManager()
```
    Description copied from interface: AsyncBucket
    
    Provides access to the AsyncBucketManager for administrative access.
    The manager lets you perform operations such as flushing a bucket or creating and managing design documents.
    
    Specified by:
    
    bucketManager in interface AsyncBucket
    
    Returns:
    
    the bucket manager for administrative operations.
  - insert
```
public <D extends Document<?>> Observable<D> insert(D document,
                                                    PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Insert a Document if it does not exist already and watch for durability constraints.
    This method works exactly like AsyncBucket.insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original insert failed because the document is already stored: DocumentAlreadyExistsException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    insert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to insert.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - insert
```
public <D extends Document<?>> Observable<D> insert(D document,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Insert a Document if it does not exist already and watch for durability constraints.
    This method works exactly like AsyncBucket.insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original insert failed because the document is already stored: DocumentAlreadyExistsException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    insert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to insert.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - upsert
```
public <D extends Document<?>> Observable<D> upsert(D document,
                                                    PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Insert or overwrite a Document and watch for durability constraints.
    This method works exactly like AsyncBucket.upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    Please note that this method will not use the Document.cas() for optimistic concurrency checks. If this behavior is needed, the AsyncBucket.replace(Document, PersistTo) method needs to be used.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    upsert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to upsert.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - upsert
```
public <D extends Document<?>> Observable<D> upsert(D document,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Insert or overwrite a Document and watch for durability constraints.
    This method works exactly like AsyncBucket.upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    Please note that this method will not use the Document.cas() for optimistic concurrency checks. If this behavior is needed, the AsyncBucket.replace(Document, ReplicateTo) method needs to be used.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    upsert in interface AsyncBucket
    
    Parameters:
    
    document - the Document to upsert.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - replace
```
public <D extends Document<?>> Observable<D> replace(D document,
                                                     PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Replace a Document if it does exist and watch for durability constraints.
    This method works exactly like AsyncBucket.replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original replace failed because the document does not exist: DocumentDoesNotExistException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - A CAS value was set and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    replace in interface AsyncBucket
    
    Parameters:
    
    document - the Document to replace.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - replace
```
public <D extends Document<?>> Observable<D> replace(D document,
                                                     ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Replace a Document if it does exist and watch for durability constraints.
    This method works exactly like AsyncBucket.replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The original replace failed because the document does not exist: DocumentDoesNotExistException
    - The request content is too big: RequestTooBigException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - A CAS value was set and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    replace in interface AsyncBucket
    
    Parameters:
    
    document - the Document to replace.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    an Observable eventually containing a new Document.
  - remove
```
public <D extends Document<?>> Observable<D> remove(D document,
                                                    PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - A CAS value was set on the Document and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    document - the document to remove, with the ID extracted.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(D document,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - A CAS value was set on the Document and it did not match with the server: CASMismatchException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    document - the document to remove, with the ID extracted.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public Observable<JsonDocument> remove(String id,
                                       PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public Observable<JsonDocument> remove(String id,
                                       ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The document to remove does not exist: DocumentDoesNotExistException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(String id,
                                                    PersistTo persistTo,
                                                    Class<D> target)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    persistTo - the persistence constraint to watch.
    
    target - the target document type to use.
    
    Returns:
    
    the document containing the ID.
  - remove
```
public <D extends Document<?>> Observable<D> remove(String id,
                                                    ReplicateTo replicateTo,
                                                    Class<D> target)
```
    Description copied from interface: AsyncBucket
    Removes a Document from the Server by its ID and apply a durability requirement.
    The Document returned just has the document ID and its CAS value set, since the value and all other associated properties have been removed from the server.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - The document to remove does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    Specified by:
    
    remove in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document to remove.
    
    replicateTo - the replication constraint to watch.
    
    target - the target document type to use.
    
    Returns:
    
    the document containing the ID.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - If the document does not exist: DocumentDoesNotExistException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - If the document does not exist: DocumentDoesNotExistException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            int expiry,
                                            PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    This method allows to set an expiration time for the document as well. It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    expiry - the new expiration time for the document.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            int expiry,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    This method allows to set an expiration time for the document as well. It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    expiry - the new expiration time for the document.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            PersistTo persistTo,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            PersistTo persistTo,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value or throw an exception if it does not exist yet.
    It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - If the document does not exist: DocumentDoesNotExistException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - counter
```
public Observable<JsonLongDocument> counter(String id,
                                            long delta,
                                            long initial,
                                            int expiry,
                                            PersistTo persistTo,
                                            ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Increment or decrement a counter with the given value and a initial value if it does not exist.
    This method allows to set an expiration time for the document as well. It is not allowed that the delta value will bring the actual value below zero.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original increment/decrement has already happened, so the actual increment/decrement and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    counter in interface AsyncBucket
    
    Parameters:
    
    id - the id of the document.
    
    delta - the increment or decrement amount.
    
    initial - the initial value to use if the document does not exist yet.
    
    expiry - the new expiration time for the document.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a Document containing the resulting value.
  - append
```
public <D extends Document<?>> Observable<D> append(D document,
                                                    PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Append a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the appended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original append has already happened, so the actual append and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    append in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is appended to the existing one.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - append
```
public <D extends Document<?>> Observable<D> append(D document,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Append a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the appended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original append has already happened, so the actual append and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    append in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is appended to the existing one.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - append
```
public <D extends Document<?>> Observable<D> append(D document,
                                                    PersistTo persistTo,
                                                    ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Append a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the appended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original append has already happened, so the actual append and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    append in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is appended to the existing one.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - prepend
```
public <D extends Document<?>> Observable<D> prepend(D document,
                                                     PersistTo persistTo)
```
    Description copied from interface: AsyncBucket
    Prepend a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the prepended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original prepend has already happened, so the actual prepend and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    prepend in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is prepended to the existing one.
    
    persistTo - the persistence constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - prepend
```
public <D extends Document<?>> Observable<D> prepend(D document,
                                                     ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Prepend a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the prepended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original prepend has already happened, so the actual prepend and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    prepend in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is prepended to the existing one.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - prepend
```
public <D extends Document<?>> Observable<D> prepend(D document,
                                                     PersistTo persistTo,
                                                     ReplicateTo replicateTo)
```
    Description copied from interface: AsyncBucket
    Prepend a Documents content to an existing one.
    The Document returned explicitly has the Document.content() set to null, because the server does not return the prepended result, so at this point the client does not know how the Document now looks like. A separate AsyncBucket.get(Document) call needs to be issued in order to get the full current content.
    If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
    Note that this method does not support expiration on the Document. If set, it will be ignored.
    The returned Observable can error under the following conditions:
    - The producer outpaces the SDK: BackpressureException
    - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException
    - The request content is too big: RequestTooBigException
    - If the document does not exist: DocumentDoesNotExistException
    - The server is currently not able to process the request, retrying may help: TemporaryFailureException
    - The server is out of memory: CouchbaseOutOfMemoryException
    - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException.
    - Unexpected errors are caught and contained in a generic CouchbaseException.
    A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original prepend has already happened, so the actual prepend and the watching for durability constraints are two separate tasks internally.
    Specified by:
    
    prepend in interface AsyncBucket
    
    Parameters:
    
    document - the document, identified by its id, from which the content is prepended to the existing one.
    
    persistTo - the persistence constraint to watch.
    
    replicateTo - the replication constraint to watch.
    
    Returns:
    
    a document which mirrors the one supplied as an argument.
  - lookupIn
```
public AsyncLookupInBuilder lookupIn(String docId)
```
    Description copied from interface: AsyncBucket
    
    Prepare a sub-document lookup through a builder API. You can use the builder to describe one or several lookup operations inside an existing JsonDocument, then execute the lookup asynchronously by calling the AsyncLookupInBuilder.execute() method. Only the paths that you looked up inside the document will be transferred over the wire, limiting the network overhead for large documents.
    
    Specified by:
    
    lookupIn in interface AsyncBucket
    
    Parameters:
    
    docId - the id of the JSON document to lookup in.
    
    Returns:
    
    a builder to describe the lookup(s) to perform.
    
    See Also:
    
    AsyncLookupInBuilder.execute()
  - mutateIn
```
public AsyncMutateInBuilder mutateIn(String docId)
```
    Description copied from interface: AsyncBucket
    
    Prepare a sub-document mutation through a builder API. You can use the builder to describe one or several mutation operations inside an existing JsonDocument, then execute them asynchronously by calling the AsyncMutateInBuilder.execute() method. Only the values that you want mutated inside the document will be transferred over the wire, limiting the network overhead for large documents. A get followed by a replace of the whole document isn’t needed anymore. Note that you can set the expiry, check the CAS and ask for durability constraints in the builder using methods prefixed by “with”: withExpiry, withCas, withDurability.
    
    Specified by:
    
    mutateIn in interface AsyncBucket
    
    Parameters:
    
    docId - the id of the JSON document to mutate in.
    
    Returns:
    
    a builder to describe the mutation(s) to perform.
    
    See Also:
    
    AsyncMutateInBuilder.execute()
  - mapGet
```
public <V> Observable<V> mapGet(String docId,
                                String key,
                                Class<V> valueType)
```
    Description copied from interface: AsyncBucket
    
    Get value of a key in the CouchbaseMap
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the key is not found in the map PathNotFoundException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapGet in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    key - key in the map
    
    valueType - value type class
    
    Returns:
    
    value if found
  - mapAdd
```
public <V> Observable<Boolean> mapAdd(String docId,
                                      String key,
                                      V value)
```
    Description copied from interface: AsyncBucket
    
    Add a key value pair into CouchbaseMap
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapAdd in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    key - key to be stored
    
    value - value to be stored
    
    Returns:
    
    true if successful
  - mapAdd
```
public <V> Observable<Boolean> mapAdd(String docId,
                                      String key,
                                      V value,
                                      MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Add a key value pair into CouchbaseMap with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - IllegalStateException if the map is full (limited by couchbase document size) - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapAdd in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    key - key to be stored
    
    value - value to be stored
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - mapRemove
```
public Observable<Boolean> mapRemove(String docId,
                                     String key)
```
    Description copied from interface: AsyncBucket
    
    Remove a key value pair from CouchbaseMap
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    key - key to be removed
    
    Returns:
    
    true if successful, even if the key doesn’t exist
  - mapRemove
```
public Observable<Boolean> mapRemove(String docId,
                                     String key,
                                     MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Remove a key value pair from CouchbaseMap with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    key - key to be removed
    
    Returns:
    
    true if successful, even if the key doesn’t exist
  - mapSize
```
public Observable<Integer> mapSize(String docId)
```
    Description copied from interface: AsyncBucket
    
    Returns the number key value pairs in CouchbaseMap
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    mapSize in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the map
    
    Returns:
    
    number of key value pairs
  - listGet
```
public <E> Observable<E> listGet(String docId,
                                 int index,
                                 Class<E> elementType)
```
    Description copied from interface: AsyncBucket
    
    Get element at an index in the CouchbaseList
    This method throws under the following conditions: - IndexOutOfBoundsException if index is not found - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the index is not found in the list PathNotFoundException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listGet in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    index - index in list
    
    elementType - element type class
    
    Returns:
    
    value if found
  - listAppend
```
public <E> Observable<Boolean> listAppend(String docId,
                                          E element)
```
    Description copied from interface: AsyncBucket
    
    Push an element to tail of CouchbaseList
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listAppend in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    element - element to be pushed into the queue
    
    Returns:
    
    true if successful
  - listAppend
```
public <E> Observable<Boolean> listAppend(String docId,
                                          E element,
                                          MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Push an element to tail of CouchbaseList with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listAppend in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    element - element to be pushed into the queue
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - listRemove
```
public Observable<Boolean> listRemove(String docId,
                                      int index)
```
    Description copied from interface: AsyncBucket
    
    Remove an element from an index in CouchbaseList
    This method throws under the following conditions: - IndexOutOfBoundsException if index is not found - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    index - index of the element in list
    
    Returns:
    
    true if successful
  - listRemove
```
public Observable<Boolean> listRemove(String docId,
                                      int index,
                                      MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Remove an element from an index in CouchbaseList with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - IndexOutOfBoundsException if index is not found - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    index - index of the element in list
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - listSet
```
public <E> Observable<Boolean> listSet(String docId,
                                       int index,
                                       E element)
```
    Description copied from interface: AsyncBucket
    
    Add an element at an index in CouchbaseList
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listSet in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    index - index in the list
    
    element - element to be added
    
    Returns:
    
    true if successful
  - listSet
```
public <E> Observable<Boolean> listSet(String docId,
                                       int index,
                                       E element,
                                       MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Add an element at an index in CouchbaseList with additional mutation options provided by MutationOptionBuilder.
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - If the underlying couchbase document does not exist: DocumentDoesNotExistException - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listSet in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    index - index in the list
    
    element - element to be added
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - listPrepend
```
public <E> Observable<Boolean> listPrepend(String docId,
                                           E element)
```
    Description copied from interface: AsyncBucket
    
    Shift list head to element in CouchbaseList
    This method throws under the following conditions: - IllegalStateException if the list is full (limited by couchbase document size) - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - If the underlying couchbase document does not exist: DocumentDoesNotExistException - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listPrepend in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    element - element to shift as head of list
    
    Returns:
    
    true if successful
  - listPrepend
```
public <E> Observable<Boolean> listPrepend(String docId,
                                           E element,
                                           MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Shift list head to element in CouchbaseList with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - If the underlying couchbase document does not exist: DocumentDoesNotExistException - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listPrepend in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    element - element to shift as head of list
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - listSize
```
public Observable<Integer> listSize(String docId)
```
    Description copied from interface: AsyncBucket
    
    Returns the number of elements in CouchbaseList
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    listSize in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the list
    
    Returns:
    
    number of elements
  - setAdd
```
public <E> Observable<Boolean> setAdd(String docId,
                                      E element)
```
    Description copied from interface: AsyncBucket
    
    Add an element into CouchbaseSet
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setAdd in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    element - element to be pushed into the set
    
    Returns:
    
    true if successful, false if the element exists in set
  - setAdd
```
public <E> Observable<Boolean> setAdd(String docId,
                                      E element,
                                      MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Add an element into CouchbaseSet with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setAdd in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    element - element to be pushed into the set
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful, false if the element exists in set
  - setContains
```
public <E> Observable<Boolean> setContains(String docId,
                                           E element)
```
    Description copied from interface: AsyncBucket
    
    Check if an element exists in CouchbaseSet
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setContains in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    element - element to check for existence
    
    Returns:
    
    true if element exists, false if the element does not exist
  - setRemove
```
public <E> Observable<E> setRemove(String docId,
                                   E element)
```
    Description copied from interface: AsyncBucket
    
    Removes an element from CouchbaseSet
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    element - element to be removed
    
    Returns:
    
    element removed from set (fails silently by returning the element is not found in set)
  - setRemove
```
public <E> Observable<E> setRemove(String docId,
                                   E element,
                                   MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Removes an element from CouchbaseSet with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setRemove in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    element - element to be removed
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    element removed from set (fails silently by returning the element is not found in set)
  - setSize
```
public Observable<Integer> setSize(String docId)
```
    Description copied from interface: AsyncBucket
    
    Returns the number of elements in CouchbaseSet
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    setSize in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the set
    
    Returns:
    
    number of elements in set
  - queuePush
```
public <E> Observable<Boolean> queuePush(String docId,
                                         E element)
```
    Description copied from interface: AsyncBucket
    
    Add an element into CouchbaseQueue
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    queuePush in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the queue
    
    element - element to be pushed into the queue
    
    Returns:
    
    true if successful
  - queuePush
```
public <E> Observable<Boolean> queuePush(String docId,
                                         E element,
                                         MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Add an element into CouchbaseQueue with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    queuePush in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the queue
    
    element - element to be pushed into the queue
    
    mutationOptionBuilder - mutation options MutationOptionBuilder
    
    Returns:
    
    true if successful
  - queuePop
```
public <E> Observable<E> queuePop(String docId,
                                  Class<E> elementType)
```
    Description copied from interface: AsyncBucket
    
    Removes the first element from CouchbaseQueue
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    queuePop in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the queue
    
    elementType - element type class
    
    Returns:
    
    element removed from queue
  - queuePop
```
public <E> Observable<E> queuePop(String docId,
                                  Class<E> elementType,
                                  MutationOptionBuilder mutationOptionBuilder)
```
    Description copied from interface: AsyncBucket
    
    Removes the first element from CouchbaseQueue with additional mutation options provided by MutationOptionBuilder
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The durability constraint could not be fulfilled because of a temporary or persistent problem: DurabilityException. - A CAS value was set and it did not match with the server: CASMismatchException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    queuePop in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the queue
    
    elementType - element type class
    
    Returns:
    
    element removed from queue
  - queueSize
```
public Observable<Integer> queueSize(String docId)
```
    Description copied from interface: AsyncBucket
    
    Returns the number of elements in CouchbaseQueue
    This method throws under the following conditions: - The producer outpaces the SDK: BackpressureException - The operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying: RequestCancelledException - If the underlying couchbase document does not exist: DocumentDoesNotExistException - The server is currently not able to process the request, retrying may help: TemporaryFailureException - The server is out of memory: CouchbaseOutOfMemoryException - Unexpected errors are caught and contained in a generic CouchbaseException.
    
    Specified by:
    
    queueSize in interface AsyncBucket
    
    Parameters:
    
    docId - document id backing the queue
    
    Returns:
    
    number of elements
  - close
```
public Observable<Boolean> close()
```
    Description copied from interface: AsyncBucket
    
    Closes the AsyncBucket.
    
    Specified by:
    
    close in interface AsyncBucket
    
    Returns:
    
    an Observable eventually containing a new Boolean after close.
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: AsyncBucket
    
    Returns true if this bucket is already closed, false if it is still open.
    
    Specified by:
    
    isClosed in interface AsyncBucket
    
    Returns:
    
    true if closed, false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - invalidateQueryCache
```
public Observable<Integer> invalidateQueryCache()
```
    Description copied from interface: AsyncBucket
    
    Invalidates and clears the internal query cache.
    This method can be used to explicitly clear the internal N1QL query cache. This cache will be filled with non-adhoc query statements (query plans) to speed up those subsequent executions.
    Triggering this method will wipe out the complete cache, which will not cause an interruption but rather all queries need to be re-prepared internally. This method is likely to be deprecated in the future once the server side query engine distributes its state throughout the cluster.
    The returned Observable will not error out under any conditions.
    
    Specified by:
    
    invalidateQueryCache in interface AsyncBucket
    
    Returns:
    
    the number of entries in the cache before it was cleared out.

Class CouchbaseAsyncBucket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CURRENT_BUCKET_IDENTIFIER

JSON_OBJECT_TRANSCODER

JSON_ARRAY_TRANSCODER

JSON_BOOLEAN_TRANSCODER

JSON_DOUBLE_TRANSCODER

JSON_LONG_TRANSCODER

JSON_STRING_TRANSCODER

RAW_JSON_TRANSCODER

LEGACY_TRANSCODER

BINARY_TRANSCODER

STRING_TRANSCODER

SERIALIZABLE_TRANSCODER

Constructor Detail

CouchbaseAsyncBucket

Method Detail

name

core

subdocumentTranscoder

n1qlQueryExecutor

environment

repository

get

get

get

exists

exists

getAndLock

getAndLock

getAndLock

getAndTouch

getAndTouch

getAndTouch

getFromReplica

getFromReplica

getFromReplica

insert

insert

upsert

upsert

replace

replace

remove

remove

remove

remove

remove

remove

query

query

query

query

query

counter

counter

counter

unlock

unlock

touch

touch

append

prepend

bucketManager

insert

insert

upsert

upsert

replace

replace

remove

remove

remove

remove

remove

remove