Package com.couchbase.client.java.kv

Class IncrementOptions

java.lang.Object

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

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

com.couchbase.client.java.kv.IncrementOptions

public class IncrementOptions
extends CommonDurabilityOptions<IncrementOptions>

Modifies properties of the increment operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IncrementOptions.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
IncrementOptions.Built	build()
IncrementOptions	delta(long delta)	The amount of which the document value should be incremented.
IncrementOptions	expiry(Duration expiry)	Sets the expiry for the document.
IncrementOptions	expiry(Instant expiry)	Sets the expiry for the document.
static IncrementOptions	incrementOptions()	Creates a new IncrementOptions.
IncrementOptions	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

incrementOptions

public static IncrementOptions incrementOptions()

Creates a new IncrementOptions.

Returns:

the created options.

delta

public IncrementOptions delta(long delta)

The amount of which the document value should be incremented.

Parameters:

delta - the amount to increment.

Returns:

this options class for chaining purposes.

initial

public IncrementOptions 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 IncrementOptions 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 IncrementOptions 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

@Internal
public IncrementOptions.Built build()