com.microsoft.azure.cosmos

Class CosmosContainerRequestOptions

java.lang.Object

com.microsoft.azure.cosmos.CosmosRequestOptions

com.microsoft.azure.cosmos.CosmosContainerRequestOptions

public class CosmosContainerRequestOptions
extends CosmosRequestOptions

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

Field Summary

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

requestOptions

Constructor Summary

Constructors

Constructor and Description
CosmosContainerRequestOptions()

Method Summary

Modifier and Type	Method and Description
ConsistencyLevel	getConsistencyLevel() Gets the consistency level required for the request.
Integer	getOfferThroughput() Gets the throughput in the form of Request Units per second when creating a cosmos container.
String	getSessionToken() Gets the token for use with session consistency.
boolean	isPopulateQuotaInfo() Gets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service.
void	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level required for the request.
void	setOfferThroughput(Integer offerThroughput) Sets the throughput in the form of Request Units per second when creating a cosmos container.
void	setPopulateQuotaInfo(boolean populateQuotaInfo) Sets the PopulateQuotaInfo setting for cosmos container read requests in the Azure Cosmos DB database service.
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

CosmosContainerRequestOptions

public CosmosContainerRequestOptions()

Method Detail

getOfferThroughput

public Integer getOfferThroughput()

Gets the throughput in the form of Request Units per second when creating a cosmos container.

Returns:

the throughput value.

setOfferThroughput

public void setOfferThroughput(Integer offerThroughput)

Sets the throughput in the form of Request Units per second when creating a cosmos container.

Parameters:

offerThroughput - the throughput value.

isPopulateQuotaInfo

public boolean isPopulateQuotaInfo()

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 void 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

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.

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