com.microsoft.azure.cosmos

Class CosmosItemRequestOptions

java.lang.Object

com.microsoft.azure.cosmos.CosmosRequestOptions

com.microsoft.azure.cosmos.CosmosItemRequestOptions

public class CosmosItemRequestOptions
extends CosmosRequestOptions

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

Field Summary

Fields inherited from class com.microsoft.azure.cosmos.CosmosRequestOptions

requestOptions

Constructor Summary

Constructors

Constructor and Description
CosmosItemRequestOptions() Constructor
CosmosItemRequestOptions(Object partitionKey) Constructor

Method Summary

Modifier and Type	Method and Description
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.
void	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
void	setIndexingDirective(IndexingDirective indexingDirective) Sets the indexing directive (index, do not index etc).
void	setPartitionKey(PartitionKey partitionKey) Sets the partition key
void	setPostTriggerInclude(List<String> postTriggerInclude) Sets the triggers to be invoked after the operation.
void	setPreTriggerInclude(List<String> preTriggerInclude) Sets the triggers to be invoked before the operation.
void	setSessionToken(String sessionToken) Sets the token for use with session consistency.
protected RequestOptions	toRequestOptions()

Methods inherited from class com.microsoft.azure.cosmos.CosmosRequestOptions

getAccessCondition, setAccessCondition

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosItemRequestOptions

public CosmosItemRequestOptions()

Constructor

CosmosItemRequestOptions

public CosmosItemRequestOptions(Object partitionKey)

Constructor

Parameters:

partitionKey - the partition key

Method Detail

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Gets the consistency level required for the request.

Returns:

the consistency level.

setConsistencyLevel

public void setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

Parameters:

consistencyLevel - the consistency level.

getIndexingDirective

public IndexingDirective getIndexingDirective()

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

Returns:

the indexing directive.

setIndexingDirective

public void setIndexingDirective(IndexingDirective indexingDirective)

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

Parameters:

indexingDirective - the indexing directive.

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 void setPreTriggerInclude(List<String> preTriggerInclude)

Sets the triggers to be invoked before the operation.

Parameters:

preTriggerInclude - the triggers to be invoked before the operation.

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 void setPostTriggerInclude(List<String> postTriggerInclude)

Sets the triggers to be invoked after the operation.

Parameters:

postTriggerInclude - the triggers to be invoked after the operation.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

setSessionToken

public void setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

setPartitionKey

public void setPartitionKey(PartitionKey partitionKey)

Sets the partition key

Parameters:

partitionKey -

toRequestOptions

protected RequestOptions toRequestOptions()

Overrides:

toRequestOptions in class CosmosRequestOptions