com.couchbase.client.java.kv

Class DecrementOptions

java.lang.Object

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

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

com.couchbase.client.java.kv.DecrementOptions

public class DecrementOptions
extends CommonDurabilityOptions<DecrementOptions>

Modifies properties of the decrement operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DecrementOptions.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 and Description
DecrementOptions.Built	build()
DecrementOptions	cas(long cas) Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.
static DecrementOptions	decrementOptions() Creates a new DecrementOptions.
DecrementOptions	delta(long delta) The amount of which the document value should be decremented.
DecrementOptions	expiry(Duration expiry) Set a custom expiration time for the document (by default no expiry is set).
DecrementOptions	initial(long initial) The initial value that should be used if the document has not been created yet.

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

decrementOptions

public static DecrementOptions decrementOptions()

Creates a new DecrementOptions.

Returns:

the created options.

delta

public DecrementOptions delta(long delta)

The amount of which the document value should be decremented.

Parameters:

delta - the amount to decrement.

Returns:

this options class for chaining purposes.

initial

public DecrementOptions initial(long initial)

The initial value that should be used if the document has not been created yet.

Parameters:

initial - the initial value to use.

Returns:

this options class for chaining purposes.

expiry

public DecrementOptions expiry(Duration expiry)

Set a custom expiration time for the document (by default no expiry is set).

Parameters:

expiry - the custom expiry value of the document.

Returns:

this options class for chaining purposes.

cas

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

build

@Stability.Internal
public DecrementOptions.Built build()