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()
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) Sets the expiry for the document.
DecrementOptions	expiry(Instant expiry) Sets the expiry for the document.
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)

Sets the expiry for the document. By default, the document will never expire.

CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.

The duration must be less than 50 years. For expiry further in the future, use expiry(Instant).

Parameters:

expiry - the duration after which the document will expire (zero duration means never expire).

Returns:

this options class for chaining purposes.

expiry

public DecrementOptions expiry(Instant expiry)

Sets the expiry for the document. By default, the document will never expire.

CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.

Parameters:

expiry - the point in time when the document will expire (epoch second zero means never expire).

Returns:

this options class for chaining purposes.

build

@Stability.Internal
public DecrementOptions.Built build()