com.microsoft.azure.cosmos

Class CosmosStoredProcedureRequestOptions

java.lang.Object

com.microsoft.azure.cosmos.CosmosRequestOptions

com.microsoft.azure.cosmos.CosmosStoredProcedureRequestOptions

public class CosmosStoredProcedureRequestOptions
extends CosmosRequestOptions

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

Field Summary

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

requestOptions

Constructor Summary

Constructors

Constructor and Description
CosmosStoredProcedureRequestOptions()

Method Summary

Modifier and Type	Method and Description
ConsistencyLevel	getConsistencyLevel() Gets the consistency level required for the request.
PartitionKey	getPartitionKey() Gets the partition key used to identify the current request's target partition.
String	getSessionToken() Gets the token for use with session consistency.
void	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
void	setPartitionKey(PartitionKey partitionKey) Sets the partition key used to identify the current request's target partition.
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

CosmosStoredProcedureRequestOptions

public CosmosStoredProcedureRequestOptions()

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.

getPartitionKey

public PartitionKey getPartitionKey()

Gets the partition key used to identify the current request's target partition.

Returns:

the partition key value.

setPartitionKey

public void setPartitionKey(PartitionKey partitionKey)

Sets the partition key used to identify the current request's target partition.

Parameters:

partitionKey - the partition key value.

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.

toRequestOptions

protected RequestOptions toRequestOptions()

Overrides:

toRequestOptions in class CosmosRequestOptions