Package com.arangodb.model

Class DocumentDeleteOptions

  • public final class DocumentDeleteOptions
extends Object
    Author:
    Mark Vollmary, Michele Rastelli
    See Also:
    API Documentation

    • Constructor Detail

      • DocumentDeleteOptions

        public DocumentDeleteOptions()

    • Method Detail

      • getWaitForSync

        public Boolean getWaitForSync()

      • waitForSync

        public DocumentDeleteOptions waitForSync​(Boolean waitForSync)
        Parameters:
        waitForSync - Wait until deletion operation has been synced to disk.
        Returns:
        options

      • getIfMatch

        public String getIfMatch()

      • ifMatch

        public DocumentDeleteOptions ifMatch​(String ifMatch)
        Parameters:
        ifMatch - remove a document based on a target revision
        Returns:
        options

      • getReturnOld

        public Boolean getReturnOld()

      • returnOld

        public DocumentDeleteOptions returnOld​(Boolean returnOld)
        Parameters:
        returnOld - Return additionally the complete previous revision of the changed document under the attribute old in the result.
        Returns:
        options

      • getSilent

        public Boolean getSilent()

      • silent

        public DocumentDeleteOptions silent​(Boolean silent)
        Parameters:
        silent - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic.
        Returns:
        options

      • getStreamTransactionId

        public String getStreamTransactionId()

      • streamTransactionId

        public DocumentDeleteOptions streamTransactionId​(String streamTransactionId)
        Parameters:
        streamTransactionId - If set, the operation will be executed within the transaction.
        Returns:
        options
        Since:
        ArangoDB 3.5.0

      • getRefillIndexCaches

        public Boolean getRefillIndexCaches()

      • refillIndexCaches

        public DocumentDeleteOptions refillIndexCaches​(Boolean refillIndexCaches)
        Parameters:
        refillIndexCaches - Whether to delete an existing entry from the in-memory edge cache and refill it with another edge if an edge document is removed.
        Returns:
        options
        Since:
        ArangoDB 3.11