Partilhar via

CosmosContainerRequestOptions Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.63.4
  • java.lang.Object
    • com.azure.cosmos.models.CosmosContainerRequestOptions

public final class CosmosContainerRequestOptions

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

Constructor Summary

Constructor Description
CosmosContainerRequestOptions()

Method Summary

Modifier and Type Method and 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosContainerRequestOptions

public CosmosContainerRequestOptions()

Method Details

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.

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.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

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

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

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

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

setSessionToken

public CosmosContainerRequestOptions setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the current request options

Applies to