Package com.couchbase.client.java.kv

Class PrependOptions

java.lang.Object

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

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

com.couchbase.client.java.kv.PrependOptions

public class PrependOptions
extends CommonDurabilityOptions<PrependOptions>

Modifies properties of the prepend operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PrependOptions.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
PrependOptions.Built	build()
PrependOptions	cas(long cas)	Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.
static PrependOptions	prependOptions()	Creates a new PrependOptions.

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 Details

prependOptions

public static PrependOptions prependOptions()

Creates a new PrependOptions.

Returns:

the created options.

cas

public PrependOptions 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 PrependOptions for chaining purposes.

build

@Internal
public PrependOptions.Built build()