Package com.couchbase.client.java.kv

Class MutateInOptions

java.lang.Object
com.couchbase.client.java.CommonOptions<SELF>
com.couchbase.client.java.kv.CommonDurabilityOptions<MutateInOptions>
com.couchbase.client.java.kv.MutateInOptions
public class MutateInOptions extends CommonDurabilityOptions<MutateInOptions>

  • Method Details

    • mutateInOptions

      public static MutateInOptions mutateInOptions()

    • expiry

      public MutateInOptions 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 MutateInOptions 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 MutateInOptions 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) or expiry(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.

    • cas

      public MutateInOptions cas(long cas)
      Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.

      The CAS value is an opaque identifier which is associated with a specific state of the document on the server. The CAS value is received on read operations (or after mutations) and can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.

      If document on the server has been modified in the meantime the SDK will raise a CasMismatchException. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.

      Parameters:
      cas - the opaque CAS identifier to use for this operation.
      Returns:
      the MutateInOptions for chaining purposes.

    • serializer

      public MutateInOptions serializer(JsonSerializer serializer)
      Customizes the serializer that is used to encoded the contents of this request.
      Parameters:
      serializer - the serializer used for encoding.
      Returns:
      this MutateInOptions for chaining purposes.

    • storeSemantics

      public MutateInOptions storeSemantics(StoreSemantics storeSemantics)
      Changes the storing semantics of the outer/enclosing document.

      While each individual MutateInSpec describes the semantics of the respective sub-document section, the StoreSemantics are applied to the outer enclosing document as a whole. You can think of using the same verb for a StoreSemantic aligns with the corresponding full document. So for example a StoreSemantics.INSERT works semantically similar to a Collection.insert(String, Object) and will fail if the document as a whole already exists.

      Parameters:
      storeSemantics - the store semantics to apply to the document.
      Returns:
      this MutateInOptions for chaining purposes.

    • accessDeleted

      @Internal public MutateInOptions accessDeleted(boolean accessDeleted)
      For internal use only: allows access to deleted documents that are in 'tombstone' form.

    • createAsDeleted

      @Internal public MutateInOptions createAsDeleted(boolean createAsDeleted)
      For internal use only: allows creating documents in 'tombstone' form.

    • build

      @Internal public MutateInOptions.Built build()