Package com.arangodb.model
Class DocumentDeleteOptions
- java.lang.Object
-
- com.arangodb.model.DocumentDeleteOptions
-
public final class DocumentDeleteOptions extends Object
- Author:
- Mark Vollmary, Michele Rastelli
- See Also:
- API Documentation
-
-
Constructor Summary
Constructors Constructor Description DocumentDeleteOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getIfMatch()
Boolean
getReturnOld()
Boolean
getSilent()
String
getStreamTransactionId()
Boolean
getWaitForSync()
DocumentDeleteOptions
ifMatch(String ifMatch)
DocumentDeleteOptions
returnOld(Boolean returnOld)
DocumentDeleteOptions
silent(Boolean silent)
DocumentDeleteOptions
streamTransactionId(String streamTransactionId)
DocumentDeleteOptions
waitForSync(Boolean waitForSync)
-
-
-
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
-
-