public class ReplaceOptions extends CommonDurabilityOptions<ReplaceOptions>
Modifier and Type | Class and Description |
---|---|
class |
ReplaceOptions.Built |
CommonDurabilityOptions.BuiltCommonDurabilityOptions
CommonOptions.BuiltCommonOptions
Modifier and Type | Method and 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)
Sets the expiry for the document.
|
ReplaceOptions |
expiry(Instant expiry)
Sets the expiry for the document.
|
ReplaceOptions |
preserveExpiry(boolean preserveExpiry)
Specifies whether the document's expiry should be preserved.
|
static ReplaceOptions |
replaceOptions() |
ReplaceOptions |
transcoder(Transcoder transcoder)
Allows to specify a custom transcoder that is used to encode the content of the request.
|
durability, durability
clientContext, parentSpan, retryStrategy, self, timeout
public static ReplaceOptions replaceOptions()
public ReplaceOptions expiry(Duration expiry)
The duration must be less than 50 years. For expiry further in the
future, use expiry(Instant)
.
expiry
- the duration after which the document will expire (zero duration means never expire).public ReplaceOptions expiry(Instant expiry)
expiry
- the point in time when the document will expire (epoch second zero means never expire).@Stability.Uncommitted @SinceCouchbase(value="7.0") public ReplaceOptions preserveExpiry(boolean preserveExpiry)
If true, the document's expiry will not be modified.
Otherwise the document's expiry is determined by
expiry(Duration)
or expiry(Instant)
.
Requires Couchbase Server 7.0 or later.
preserveExpiry
- true to preserve expiry, false to set new expirypublic ReplaceOptions transcoder(Transcoder transcoder)
transcoder
- the custom transcoder that should be used for encoding.ReplaceOptions
to allow method chaining.public ReplaceOptions cas(long cas)
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.
cas
- the opaque CAS identifier to use for this operation.ReplaceOptions
for chaining purposes.@Stability.Internal public ReplaceOptions.Built build()
Copyright © 2024 Couchbase, Inc.. All rights reserved.