Interface BinarySubdocMutationRequest

    • Method Detail

      • expiration

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

        ByteBuf fragment()
        A ByteBuf containing the JSON fragment for the mutation. It is appended to the BinarySubdocRequest.content(). This buffer is to be automatically released once the content has been written on the wire.
        Returns:
        the target value for the mutation (a fragment of the whole JSON document, valid JSON itself)
      • createIntermediaryPath

        boolean createIntermediaryPath()
        Sets whether missing nodes in the BinarySubdocRequest.path() should be created as part of this mutation, when possible. This is represented as an additional flag on the wire.
        Returns:
        true if missing JSON nodes in the path should be created, false otherwise.
      • cas

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

        boolean xattr()
        Access to extended attribute section of the couchbase document
        Returns:
        true if accessing extended attribute section
      • expandMacros

        boolean expandMacros()
        Sets whether macros such as ${Mutation.CAS} should be expanded
        Returns:
        true iff macros should be expanded
      • createDocument

        @Deprecated
        boolean createDocument()
        Deprecated.
        Create document if it does not exist. It is deprecated, use upsertDocument()
        Returns:
        true if creating document
      • upsertDocument

        boolean upsertDocument()
        Upsert document if it does not exist
        Returns:
        true if creating document
      • insertDocument

        boolean insertDocument()
        Add document only if it does not exist
        Returns:
        true if adding document