Package 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 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DecrementOptions.Built
build()
DecrementOptions
cas(long cas)
Set the CAS from a previous read operation to perform optimistic concurrency.static DecrementOptions
decrementOptions()
Creates a newDecrementOptions
.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
-
-
-
-
Method Detail
-
decrementOptions
public static DecrementOptions decrementOptions()
Creates a newDecrementOptions
.- 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)
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 DecrementOptions.Built build()
-
-