Package 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 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description InsertOptions.Built
build()
InsertOptions
expiry(Duration expiry)
Sets the expiry for the document.InsertOptions
expiry(Instant expiry)
Sets the expiry for the document.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
-
-
-
-
Method Detail
-
insertOptions
public static InsertOptions insertOptions()
-
expiry
public InsertOptions 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 InsertOptions 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.
-
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
@Internal public InsertOptions.Built build()
-
-