com.azure.cosmos

Class CosmosContainerRequestOptions

java.lang.Object

com.azure.cosmos.CosmosContainerRequestOptions

public class CosmosContainerRequestOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
CosmosContainerRequestOptions()

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.
boolean	getPopulateQuotaInfo() Gets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service.
String	getSessionToken() Gets the token for use with session consistency.
CosmosContainerRequestOptions	setAccessCondition(AccessCondition accessCondition) Sets the conditions associated with the request.
CosmosContainerRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
CosmosContainerRequestOptions	setPopulateQuotaInfo(boolean populateQuotaInfo) Sets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service.
CosmosContainerRequestOptions	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

CosmosContainerRequestOptions

public CosmosContainerRequestOptions()

Method Detail

getPopulateQuotaInfo

public boolean getPopulateQuotaInfo()

Gets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting cosmos container quota related stats for document collection read requests.

Returns:

true if PopulateQuotaInfo is enabled

setPopulateQuotaInfo

public CosmosContainerRequestOptions setPopulateQuotaInfo(boolean populateQuotaInfo)

Sets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting cosmos container quota related stats for document collection read requests.

Parameters:

populateQuotaInfo - a boolean value indicating whether PopulateQuotaInfo is enabled or not

Returns:

the current request options

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Gets the consistency level required for the request.

Returns:

the consistency level.

setConsistencyLevel

public CosmosContainerRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the consistency level required for the request.

Parameters:

consistencyLevel - the consistency level.

Returns:

the current request options

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

setSessionToken

public CosmosContainerRequestOptions setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the current request options

getAccessCondition

public AccessCondition getAccessCondition()

Gets the conditions associated with the request.

Returns:

the access condition.

setAccessCondition

public CosmosContainerRequestOptions setAccessCondition(AccessCondition accessCondition)

Sets the conditions associated with the request.

Parameters:

accessCondition - the access condition.

Returns:

the current request options