Package com.couchbase.client.java.kv
Class UpsertOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<SELF>
-
- com.couchbase.client.java.kv.CommonDurabilityOptions<UpsertOptions>
-
- com.couchbase.client.java.kv.UpsertOptions
-
public class UpsertOptions extends CommonDurabilityOptions<UpsertOptions>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
UpsertOptions.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 UpsertOptions.Built
build()
UpsertOptions
expiry(Duration expiry)
Sets the expiry for the document.UpsertOptions
expiry(Instant expiry)
Sets the expiry for the document.UpsertOptions
preserveExpiry(boolean preserveExpiry)
Specifies whether an existing document's expiry should be preserved.UpsertOptions
transcoder(Transcoder transcoder)
Allows to specify a custom transcoder that is used to encode the content of the request.static UpsertOptions
upsertOptions()
-
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
-
upsertOptions
public static UpsertOptions upsertOptions()
-
expiry
public UpsertOptions expiry(Duration expiry)
Sets the expiry for the document. By default the document will never expire.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 UpsertOptions expiry(Instant expiry)
Sets the expiry for the document. By default the document will never expire.- Parameters:
expiry
- the point in time when the document will expire (epoch second zero means never expire).- Returns:
- this options class for chaining purposes.
-
preserveExpiry
@Uncommitted @SinceCouchbase("7.0") public UpsertOptions preserveExpiry(boolean preserveExpiry)
Specifies whether an existing document's expiry should be preserved. Defaults to false.If true, and the document exists, its expiry will not be modified. Otherwise the document's expiry is determined by
expiry(Duration)
orexpiry(Instant)
.Requires Couchbase Server 7.0 or later.
- Parameters:
preserveExpiry
- true to preserve expiry, false to set new expiry- Returns:
- this options class for chaining purposes.
-
transcoder
public UpsertOptions transcoder(Transcoder transcoder)
Allows to specify a custom transcoder that is used to encode the content of the request.- Parameters:
transcoder
- the custom transcoder that should be used for encoding.- Returns:
- the
UpsertOptions
to allow method chaining.
-
build
@Internal public UpsertOptions.Built build()
-
-