Package com.couchbase.client.java.kv

Class IncrementOptions

java.lang.Object
com.couchbase.client.java.CommonOptions<SELF>
com.couchbase.client.java.kv.CommonDurabilityOptions<IncrementOptions>
com.couchbase.client.java.kv.IncrementOptions
public class IncrementOptions extends CommonDurabilityOptions<IncrementOptions>
Modifies properties of the increment operation.

  • Method Details

    • incrementOptions

      public static IncrementOptions incrementOptions()
      Creates a new IncrementOptions.
      Returns:
      the created options.

    • delta

      public IncrementOptions delta(long delta)
      The amount of which the document value should be incremented.
      Parameters:
      delta - the amount to increment.
      Returns:
      this options class for chaining purposes.

    • initial

      public IncrementOptions initial(long initial)
      The initial value that should be used if the document has not been created yet.
      Parameters:
      initial - the initial value to use.
      Returns:
      this options class for chaining purposes.

    • expiry

      public IncrementOptions expiry(Duration expiry)
      Sets the expiry for the document. By default, the document will never expire.

      CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.

      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 IncrementOptions expiry(Instant expiry)
      Sets the expiry for the document. By default, the document will never expire.

      CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.

      Parameters:
      expiry - the point in time when the document will expire (epoch second zero means never expire).
      Returns:
      this options class for chaining purposes.

    • build

      @Internal public IncrementOptions.Built build()