Package com.azure.data.cosmos

Class CosmosStoredProcedureRequestOptions

java.lang.Object

com.azure.data.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	Description
CosmosStoredProcedureRequestOptions()

Method Summary

Modifier and Type	Method	Description
AccessCondition	accessCondition()	Gets the conditions associated with the request.
CosmosStoredProcedureRequestOptions	accessCondition(AccessCondition accessCondition)	Sets the conditions associated with the request.
ConsistencyLevel	consistencyLevel()	Gets the consistency level required for the request.
CosmosStoredProcedureRequestOptions	consistencyLevel(ConsistencyLevel consistencyLevel)	Sets the consistency level required for the request.
PartitionKey	partitionKey()	Gets the partition key used to identify the current request's target partition.
CosmosStoredProcedureRequestOptions	partitionKey(PartitionKey partitionKey)	Sets the partition key used to identify the current request's target partition.
String	sessionToken()	Gets the token for use with session consistency.
CosmosStoredProcedureRequestOptions	sessionToken(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

accessCondition

public AccessCondition accessCondition()

Gets the conditions associated with the request.

Returns:

the access condition.

accessCondition

public CosmosStoredProcedureRequestOptions accessCondition(AccessCondition accessCondition)

Sets the conditions associated with the request.

Parameters:

accessCondition - the access condition.

Returns:

the current request options

consistencyLevel

public ConsistencyLevel consistencyLevel()

Gets the consistency level required for the request.

Returns:

the consistency level.

consistencyLevel

public CosmosStoredProcedureRequestOptions consistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

Parameters:

consistencyLevel - the consistency level.

Returns:

the CosmosStoredProcedureRequestOptions.

partitionKey

public PartitionKey partitionKey()

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

Returns:

the partition key value.

partitionKey

public CosmosStoredProcedureRequestOptions partitionKey(PartitionKey partitionKey)

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

Parameters:

partitionKey - the partition key value.

Returns:

the CosmosStoredProcedureRequestOptions.

sessionToken

public String sessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

sessionToken

public CosmosStoredProcedureRequestOptions sessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the CosmosStoredProcedureRequestOptions.