| Package | Description |
|---|---|
| com.couchbase.client.java | |
| com.couchbase.client.java.datastructures |
| Modifier and Type | Method and Description |
|---|---|
<E> boolean |
Bucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
Push an element to tail of CouchbaseList with additional mutation options provided by
MutationOptionBuilder. |
<E> boolean |
CouchbaseBucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
CouchbaseAsyncBucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
AsyncBucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
Bucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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
- The durability constraint could not be fulfilled because of a temporary or persistent problem:
DurabilityException. |
<E> boolean |
CouchbaseBucket.listAppend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> boolean |
Bucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
CouchbaseBucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
CouchbaseAsyncBucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
AsyncBucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
Bucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> boolean |
CouchbaseBucket.listPrepend(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
boolean |
Bucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder)
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. |
boolean |
CouchbaseBucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder) |
rx.Observable<Boolean> |
CouchbaseAsyncBucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder) |
rx.Observable<Boolean> |
AsyncBucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder)
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. |
boolean |
Bucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
boolean |
CouchbaseBucket.listRemove(String docId,
int index,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> boolean |
Bucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
CouchbaseBucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
CouchbaseAsyncBucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
AsyncBucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder)
Add an element at an index in CouchbaseList with additional mutation options provided by
MutationOptionBuilder. |
<E> boolean |
Bucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> boolean |
CouchbaseBucket.listSet(String docId,
int index,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<V> boolean |
Bucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder)
Add a key value pair into CouchbaseMap with additional mutation options provided by
MutationOptionBuilder
If the underlying document for the map does not exist, this operation will create a new document to back
the data structure. |
<V> boolean |
CouchbaseBucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder) |
<V> rx.Observable<Boolean> |
CouchbaseAsyncBucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder) |
<V> rx.Observable<Boolean> |
AsyncBucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder)
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. |
<V> boolean |
Bucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
Add a key value pair into CouchbaseMap with additional mutation options provided by
MutationOptionBuilder
If the underlying document for the map does not exist, this operation will create a new document to back
the data structure. |
<V> boolean |
CouchbaseBucket.mapAdd(String docId,
String key,
V value,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
boolean |
Bucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder)
Remove a key value pair from CouchbaseMap with additional mutation options provided by
MutationOptionBuilder. |
boolean |
CouchbaseBucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder) |
rx.Observable<Boolean> |
CouchbaseAsyncBucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder) |
rx.Observable<Boolean> |
AsyncBucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder)
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. |
boolean |
Bucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
Remove a key value pair from CouchbaseMap with additional mutation options provided by
MutationOptionBuilder. |
boolean |
CouchbaseBucket.mapRemove(String docId,
String key,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> E |
Bucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> E |
CouchbaseBucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<E> |
CouchbaseAsyncBucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<E> |
AsyncBucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> E |
Bucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> E |
CouchbaseBucket.queuePop(String docId,
Class<E> elementType,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> boolean |
Bucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
CouchbaseBucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
CouchbaseAsyncBucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
AsyncBucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
Bucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> boolean |
CouchbaseBucket.queuePush(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> boolean |
Bucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
CouchbaseBucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
CouchbaseAsyncBucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<Boolean> |
AsyncBucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> boolean |
Bucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> boolean |
CouchbaseBucket.setAdd(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
<E> E |
Bucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> E |
CouchbaseBucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<E> |
CouchbaseAsyncBucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder) |
<E> rx.Observable<E> |
AsyncBucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder)
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. |
<E> E |
Bucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit)
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. |
<E> E |
CouchbaseBucket.setRemove(String docId,
E element,
MutationOptionBuilder mutationOptionBuilder,
long timeout,
TimeUnit timeUnit) |
| Modifier and Type | Method and Description |
|---|---|
static MutationOptionBuilder |
MutationOptionBuilder.builder() |
MutationOptionBuilder |
MutationOptionBuilder.cas(long cas)
Set cas for optimistic locking on option builder
|
MutationOptionBuilder |
MutationOptionBuilder.createDocument(boolean createDoc)
createDocument On true, creates the document if it does not exist
|
MutationOptionBuilder |
MutationOptionBuilder.expiry(int expiry)
Set expiration on option builder
|
MutationOptionBuilder |
MutationOptionBuilder.persistTo(PersistTo persistTo)
Set persistence durability constraints on option builder
|
MutationOptionBuilder |
MutationOptionBuilder.replicateTo(ReplicateTo replicateTo)
Set replication durability constraints on option builder
|
Copyright © 2015 Couchbase, Inc.