Package com.couchbase.client.java.kv

Class DecrementOptions

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

  • Method Details

    • decrementOptions

      public static DecrementOptions decrementOptions()
      Creates a new DecrementOptions.
      Returns:
      the created options.

    • delta

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

    • initial

      public DecrementOptions 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 DecrementOptions 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 DecrementOptions 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 DecrementOptions.Built build()