CosmosBatchPatchItemRequestOptions Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.67.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions

public final class CosmosBatchPatchItemRequestOptions

Encapsulates options that can be specified for an operation within a CosmosBatch.

Constructor Summary

Constructor	Description
CosmosBatchPatchItemRequestOptions()	Constructor

Method Summary

Modifier and Type	Method and Description
String	getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
String	getIfMatchETag() Gets the If-Match (ETag) associated with the operation in CosmosBatch.
String	getIfNoneMatchETag() Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
CosmosBatchPatchItemRequestOptions	setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
CosmosBatchPatchItemRequestOptions	setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosBatch.
CosmosBatchPatchItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosBatchPatchItemRequestOptions

public CosmosBatchPatchItemRequestOptions()

Constructor

Method Details

getFilterPredicate

public String getFilterPredicate()

Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.

Returns:

the FilterPredicate associated with the request.

getIfMatchETag

public String getIfMatchETag()

Gets the If-Match (ETag) associated with the operation in CosmosBatch. Most commonly used with replace, upsert and delete requests. This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. For more details, refer to optimistic concurrency control documentation

Returns:

ifMatchETag the ifMatchETag associated with the request.

getIfNoneMatchETag

public String getIfNoneMatchETag()

Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. Most commonly used to detect changes to the resource via read requests. When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. To match any Etag use "*" This will be ignored if specified for write requests (ex: Create, Replace, Delete). For more details, refer to optimistic concurrency control documentation

Returns:

the ifNoneMatchETag associated with the request.

setFilterPredicate

public CosmosBatchPatchItemRequestOptions setFilterPredicate(String filterPredicate)

Sets the FilterPredicate associated with the request in the Azure Cosmos DB service. for example: setFilterPredicate("from c where c.taskNum = 3").

Parameters:

filterPredicate - the filterPredicate associated with the request.

Returns:

the current request options

setIfMatchETag

public CosmosBatchPatchItemRequestOptions setIfMatchETag(String ifMatchETag)

Sets the If-Match (ETag) associated with the operation in CosmosBatch. Most commonly used with replace, upsert and delete requests. This will be ignored if specified for create requests or for upsert requests if the item doesn't exist. For more details, refer to optimistic concurrency control documentation

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

Returns:

the current request options

setIfNoneMatchETag

public CosmosBatchPatchItemRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)

Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch. Most commonly used to detect changes to the resource via read requests. When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. To match any Etag use "*" This will be ignored if specified for write requests (ex: Create, Replace, Delete). For more details, refer to optimistic concurrency control documentation

Parameters:

ifNoneMatchEtag - the ifNoneMatchETag associated with the request.

Returns:

the current request options

Azure SDK for Java

Latest