com.azure.cosmos

Class CosmosStoredProcedureRequestOptions

java.lang.Object

com.azure.cosmos.CosmosStoredProcedureRequestOptions

public class CosmosStoredProcedureRequestOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
CosmosStoredProcedureRequestOptions()

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.
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.
CosmosStoredProcedureRequestOptions	setAccessCondition(AccessCondition accessCondition) Sets the conditions associated with the request.
CosmosStoredProcedureRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
CosmosStoredProcedureRequestOptions	setPartitionKey(PartitionKey partitionKey) Sets the partition key used to identify the current request's target partition.
CosmosStoredProcedureRequestOptions	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

CosmosStoredProcedureRequestOptions

public CosmosStoredProcedureRequestOptions()

Method Detail

getAccessCondition

public AccessCondition getAccessCondition()

Gets the conditions associated with the request.

Returns:

the access condition.

setAccessCondition

public CosmosStoredProcedureRequestOptions 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 CosmosStoredProcedureRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

Parameters:

consistencyLevel - the consistency level.

Returns:

the CosmosStoredProcedureRequestOptions.

getPartitionKey

public PartitionKey getPartitionKey()

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

Returns:

the partition key value.

setPartitionKey

public CosmosStoredProcedureRequestOptions setPartitionKey(PartitionKey partitionKey)

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

Parameters:

partitionKey - the partition key value.

Returns:

the CosmosStoredProcedureRequestOptions.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

setSessionToken

public CosmosStoredProcedureRequestOptions setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the CosmosStoredProcedureRequestOptions.