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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IncrementOptions.Built
build()
IncrementOptions
cas(long cas)
Set the CAS from a previous read operation to perform optimistic concurrency.IncrementOptions
delta(long delta)
The amount of which the document value should be incremented.IncrementOptions
expiry(Duration expiry)
Set a custom expiration time for the document (by default no expiry is set).static IncrementOptions
incrementOptions()
Creates a newIncrementOptions
.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
-
-
-
-
Method Detail
-
incrementOptions
public static IncrementOptions incrementOptions()
Creates a newIncrementOptions
.- 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)
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 IncrementOptions cas(long cas)
Set the CAS from a previous read operation to perform optimistic concurrency.- Parameters:
cas
- the CAS to use for this operation.- Returns:
- this options class for chaining purposes.
-
build
@Internal public IncrementOptions.Built build()
-
-