com.azure.cosmos

Class CosmosItemRequestOptions

java.lang.Object

com.azure.cosmos.CosmosItemRequestOptions

public class CosmosItemRequestOptions
extends Object

Encapsulates options that can be specified for a request issued to cosmos Item.

Constructor Summary

Constructors

Constructor and Description
CosmosItemRequestOptions() Constructor

Method Summary

Modifier and Type	Method and Description
AccessCondition	getAccessCondition() Gets the conditions associated with the request.
ConsistencyLevel	getConsistencyLevel() Gets the consistency level required for the request.
IndexingDirective	getIndexingDirective() Gets the indexing directive (index, do not index etc).
List<String>	getPostTriggerInclude() Gets the triggers to be invoked after the operation.
List<String>	getPreTriggerInclude() Gets the triggers to be invoked before the operation.
String	getSessionToken() Gets the token for use with session consistency.
CosmosItemRequestOptions	setAccessCondition(AccessCondition accessCondition) Sets the conditions associated with the request.
CosmosItemRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
CosmosItemRequestOptions	setIndexingDirective(IndexingDirective indexingDirective) Sets the indexing directive (index, do not index etc).
CosmosItemRequestOptions	setPostTriggerInclude(List<String> postTriggerInclude) Sets the triggers to be invoked after the operation.
CosmosItemRequestOptions	setPreTriggerInclude(List<String> preTriggerInclude) Sets the triggers to be invoked before the operation.
CosmosItemRequestOptions	setSessionToken(String sessionToken) Sets the token for use with session consistency.

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosItemRequestOptions

public CosmosItemRequestOptions()

Constructor

Method Detail

getAccessCondition

public AccessCondition getAccessCondition()

Gets the conditions associated with the request.

Returns:

the access condition.

setAccessCondition

public CosmosItemRequestOptions setAccessCondition(AccessCondition accessCondition)

Sets the conditions associated with the request.

Parameters:

accessCondition - the access condition.

Returns:

the current request options

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Gets the consistency level required for the request.

Returns:

the consistency level.

setConsistencyLevel

public CosmosItemRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

Parameters:

consistencyLevel - the consistency level.

Returns:

the CosmosItemRequestOptions.

getIndexingDirective

public IndexingDirective getIndexingDirective()

Gets the indexing directive (index, do not index etc).

Returns:

the indexing directive.

setIndexingDirective

public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)

Sets the indexing directive (index, do not index etc).

Parameters:

indexingDirective - the indexing directive.

Returns:

the CosmosItemRequestOptions.

getPreTriggerInclude

public List<String> getPreTriggerInclude()

Gets the triggers to be invoked before the operation.

Returns:

the triggers to be invoked before the operation.

setPreTriggerInclude

public CosmosItemRequestOptions setPreTriggerInclude(List<String> preTriggerInclude)

Sets the triggers to be invoked before the operation.

Parameters:

preTriggerInclude - the triggers to be invoked before the operation.

Returns:

the CosmosItemRequestOptions.

getPostTriggerInclude

public List<String> getPostTriggerInclude()

Gets the triggers to be invoked after the operation.

Returns:

the triggers to be invoked after the operation.

setPostTriggerInclude

public CosmosItemRequestOptions setPostTriggerInclude(List<String> postTriggerInclude)

Sets the triggers to be invoked after the operation.

Parameters:

postTriggerInclude - the triggers to be invoked after the operation.

Returns:

the CosmosItemRequestOptions.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

setSessionToken

public CosmosItemRequestOptions setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the CosmosItemRequestOptions.