Package com.couchbase.client.java.kv

Class MutateInOptions

java.lang.Object

com.couchbase.client.java.CommonOptions<SELF>

com.couchbase.client.java.kv.CommonDurabilityOptions<MutateInOptions>

com.couchbase.client.java.kv.MutateInOptions

public class MutateInOptions
extends CommonDurabilityOptions<MutateInOptions>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MutateInOptions.Built

Nested classes/interfaces inherited from class com.couchbase.client.java.kv.CommonDurabilityOptions

CommonDurabilityOptions.BuiltCommonDurabilityOptions

Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method	Description
MutateInOptions	accessDeleted(boolean accessDeleted)	For internal use only: allows access to deleted documents that are in 'tombstone' form.
MutateInOptions.Built	build()
MutateInOptions	cas(long cas)	Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.
MutateInOptions	createAsDeleted(boolean createAsDeleted)	For internal use only: allows creating documents in 'tombstone' form.
MutateInOptions	expiry(Duration expiry)
static MutateInOptions	mutateInOptions()
MutateInOptions	serializer(JsonSerializer serializer)
MutateInOptions	storeSemantics(StoreSemantics storeSemantics)

Methods inherited from class com.couchbase.client.java.kv.CommonDurabilityOptions

durability, durability

Methods inherited from class com.couchbase.client.java.CommonOptions

clientContext, parentSpan, retryStrategy, self, timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mutateInOptions

public static MutateInOptions mutateInOptions()

expiry

public MutateInOptions expiry(Duration expiry)

cas

public MutateInOptions cas(long cas)

Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.

The CAS value is an opaque identifier which is associated with a specific state of the document on the server. The CAS value is received on read operations (or after mutations) and can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.

If document on the server has been modified in the meantime the SDK will raise a CasMismatchException. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.

Parameters:

cas - the opaque CAS identifier to use for this operation.

Returns:

the MutateInOptions for chaining purposes.

serializer

public MutateInOptions serializer(JsonSerializer serializer)

storeSemantics

public MutateInOptions storeSemantics(StoreSemantics storeSemantics)

accessDeleted

@Internal
public MutateInOptions accessDeleted(boolean accessDeleted)

For internal use only: allows access to deleted documents that are in 'tombstone' form.

createAsDeleted

@Internal
public MutateInOptions createAsDeleted(boolean createAsDeleted)

For internal use only: allows creating documents in 'tombstone' form.

build

@Internal
public MutateInOptions.Built build()