Package com.azure.cosmos.models

Class CosmosContainerRequestOptions

java.lang.Object

com.azure.cosmos.models.CosmosContainerRequestOptions

public final class CosmosContainerRequestOptions
extends Object

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

Constructor Summary

Constructors

Constructor	Description
CosmosContainerRequestOptions()

Method Summary

Modifier and Type	Method	Description
String	getIfMatchETag()	Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
String	getIfNoneMatchETag()	Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
String	getSessionToken()	Gets the token for use with session consistency.
boolean	isQuotaInfoEnabled()	Gets the quotaInfoEnabled setting for cosmos container read requests in the Azure Cosmos DB database service.
CosmosContainerRequestOptions	setIfMatchETag(String ifMatchETag)	Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosContainerRequestOptions	setIfNoneMatchETag(String ifNoneMatchETag)	Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosContainerRequestOptions	setQuotaInfoEnabled(boolean quotaInfoEnabled)	Sets the quotaInfoEnabled 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

isQuotaInfoEnabled

public boolean isQuotaInfoEnabled()

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

Returns:

true if quotaInfoEnabled is enabled

setQuotaInfoEnabled

public CosmosContainerRequestOptions setQuotaInfoEnabled(boolean quotaInfoEnabled)

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

Parameters:

quotaInfoEnabled - a boolean value indicating whether quotaInfoEnabled is enabled or not

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

getIfMatchETag

public String getIfMatchETag()

Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.

Returns:

the ifMatchETag associated with the request.

setIfMatchETag

public CosmosContainerRequestOptions setIfMatchETag(String ifMatchETag)

Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

Returns:

the current request options

getIfNoneMatchETag

public String getIfNoneMatchETag()

Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.

Returns:

the ifNoneMatchETag associated with the request.

setIfNoneMatchETag

public CosmosContainerRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)

Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.

Parameters:

ifNoneMatchETag - the ifNoneMatchETag associated with the request.

Returns:

the current request options