Package com.couchbase.client.java.kv
Class ReplaceOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<SELF>
-
- com.couchbase.client.java.kv.CommonDurabilityOptions<ReplaceOptions>
-
- com.couchbase.client.java.kv.ReplaceOptions
-
public class ReplaceOptions extends CommonDurabilityOptions<ReplaceOptions>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
ReplaceOptions.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 ReplaceOptions.Built
build()
ReplaceOptions
cas(long cas)
Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.ReplaceOptions
expiry(Duration expiry)
static ReplaceOptions
replaceOptions()
ReplaceOptions
transcoder(Transcoder transcoder)
-
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
-
replaceOptions
public static ReplaceOptions replaceOptions()
-
expiry
public ReplaceOptions expiry(Duration expiry)
-
transcoder
public ReplaceOptions transcoder(Transcoder transcoder)
-
cas
public ReplaceOptions 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
ReplaceOptions
for chaining purposes.
-
build
@Internal public ReplaceOptions.Built build()
-
-