Package com.arangodb.model

Class DocumentDeleteOptions

java.lang.Object

com.arangodb.model.TransactionalOptions<DocumentDeleteOptions>

com.arangodb.model.DocumentDeleteOptions

public final class DocumentDeleteOptions
extends TransactionalOptions<DocumentDeleteOptions>

Author:

Mark Vollmary, Michele Rastelli

Constructor Summary

Constructors

Constructor	Description
DocumentDeleteOptions()

Method Summary

Modifier and Type	Method	Description
String	getIfMatch()
Boolean	getIgnoreRevs()
Boolean	getRefillIndexCaches()
Boolean	getReturnOld()
Boolean	getSilent()
Boolean	getWaitForSync()
DocumentDeleteOptions	ifMatch(String ifMatch)
DocumentDeleteOptions	ignoreRevs(Boolean ignoreRevs)
DocumentDeleteOptions	refillIndexCaches(Boolean refillIndexCaches)
DocumentDeleteOptions	returnOld(Boolean returnOld)
DocumentDeleteOptions	silent(Boolean silent)
DocumentDeleteOptions	waitForSync(Boolean waitForSync)

Methods inherited from class com.arangodb.model.TransactionalOptions

getStreamTransactionId, streamTransactionId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

getIgnoreRevs

public Boolean getIgnoreRevs()

ignoreRevs

public DocumentDeleteOptions ignoreRevs(Boolean ignoreRevs)

Parameters:

ignoreRevs - If set to true, ignore any _rev attribute in the selectors. No revision check is performed. If set to false then revisions are checked. The default is true.

Returns:

options