com.arangodb.model

Class DocumentReplaceOptions

java.lang.Object

com.arangodb.model.DocumentReplaceOptions

public class DocumentReplaceOptions
extends Object

Author:

Mark Vollmary

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
DocumentReplaceOptions()

Method Summary

Modifier and Type	Method and Description
String	getIfMatch()
Boolean	getIgnoreRevs()
Boolean	getReturnNew()
Boolean	getReturnOld()
Boolean	getSilent()
Boolean	getWaitForSync()
DocumentReplaceOptions	ifMatch(String ifMatch)
DocumentReplaceOptions	ignoreRevs(Boolean ignoreRevs)
DocumentReplaceOptions	returnNew(Boolean returnNew)
DocumentReplaceOptions	returnOld(Boolean returnOld)
DocumentReplaceOptions	silent(Boolean silent)
DocumentReplaceOptions	waitForSync(Boolean waitForSync)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentReplaceOptions

public DocumentReplaceOptions()

Method Detail

getWaitForSync

public Boolean getWaitForSync()

waitForSync

public DocumentReplaceOptions waitForSync(Boolean waitForSync)

Parameters:

waitForSync - Wait until document has been synced to disk.

Returns:

options

getIgnoreRevs

public Boolean getIgnoreRevs()

ignoreRevs

public DocumentReplaceOptions ignoreRevs(Boolean ignoreRevs)

Parameters:

ignoreRevs - By default, or if this is set to true, the _rev attributes in the given document is ignored. If this is set to false, then the _rev attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified.

Returns:

options

getIfMatch

public String getIfMatch()

ifMatch

public DocumentReplaceOptions ifMatch(String ifMatch)

Parameters:

ifMatch - replace a document based on target revision

Returns:

options

getReturnNew

public Boolean getReturnNew()

returnNew

public DocumentReplaceOptions returnNew(Boolean returnNew)

Parameters:

returnNew - Return additionally the complete new document under the attribute new in the result.

Returns:

options

getReturnOld

public Boolean getReturnOld()

returnOld

public DocumentReplaceOptions 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 DocumentReplaceOptions 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