com.couchbase.client.java.kv

Class InsertOptions

java.lang.Object

com.couchbase.client.java.CommonOptions<SELF>

com.couchbase.client.java.kv.CommonDurabilityOptions<InsertOptions>

com.couchbase.client.java.kv.InsertOptions

public class InsertOptions
extends CommonDurabilityOptions<InsertOptions>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	InsertOptions.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

Modifier and Type	Method and Description
InsertOptions.Built	build()
InsertOptions	expiry(Duration expiry) Sets the expiry time for the document as a relative duration.
InsertOptions	expiry(Instant expiry) Sets the expiry time for the document as a absolute duration.
static InsertOptions	insertOptions()
InsertOptions	transcoder(Transcoder transcoder) Allows to specify a custom transcoder that is used to encode the content of the request.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

insertOptions

public static InsertOptions insertOptions()

expiry

public InsertOptions expiry(Duration expiry)

Sets the expiry time for the document as a relative duration.

IMPORTANT: we recommend using a relative duration only if the provided value is less than 30 days. The reason is that the server will assume any value larger than that to be an absolute unix timestamp. The SDK tries its best to coerce it into sane values, but to avoid any unexpected behavior please stick to the less than 30 days as a relative duration. For every expiry > 30 days, please provide it as an absolute instant through the expiry(Instant) overload.

Parameters:

expiry - the expiry time as a relative duration.

Returns:

this InsertOptions for chaining purposes.

expiry

public InsertOptions expiry(Instant expiry)

Sets the expiry time for the document as a absolute duration.

Note that the absolute instant will be converted into a unix timestamp in seconds before sending it over the wire to the server. If you need to provide a relative duration you can use expiry(Duration) but please see its javadoc for common pitfalls and edge cases. If in doubt, please provide it as an absolute instant on this overload.

Parameters:

expiry - the expiry time as an absolute instant.

Returns:

this InsertOptions for chaining purposes.

transcoder

public InsertOptions 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 InsertOptions to allow method chaining.

build

@Stability.Internal
public InsertOptions.Built build()