Interface BinarySubdocMultiMutationRequest

All Superinterfaces:
BinaryRequest, CouchbaseMessage, CouchbaseRequest
All Known Implementing Classes:
SubMultiMutationRequest

@Committed
@Public
public interface BinarySubdocMultiMutationRequest
extends BinaryRequest
A BinarySubdocRequest that describes multiple mutations on a single document. The mutations are applied atomically, so they either all succeed or none is applied. Each MutationCommand can act on a different path inside the document and be of a different nature. A multi-mutation request can also alter the enclosing document's expiry and flags.
Since:
1.2
Author:
Simon Baslé
  • Method Details

    • expiration

      int expiration()
      Returns:
      the expiration (or TTL) to apply to the document along the mutations, 0 for no TTL.
    • cas

      long cas()
      Returns:
      the CAS to use for the mutations (if needed) or 0L to ignore
    • docFlags

      byte docFlags()
      Returns:
      the document flags for the Request
    • commands

      List<MutationCommand> commands()
      Returns:
      a list of the MutationCommand describing the multiple mutations to apply.
    • content

      ByteBuf content()
      The ByteBuf representing the whole list of commands(). This buffer is to be automatically released once the message has been written on the wire.
      Returns:
      the ByteBuf to serve as a memcached protocol message body.