CosmosBatchItemRequestOptions Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.80.0

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

public final class CosmosBatchItemRequestOptions

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

Constructor Summary

Constructor	Description
CosmosBatchItemRequestOptions()	Creates a new CosmosBatchItemRequestOptions object.

Method Summary

Modifier and Type	Method and Description
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.
CosmosBatchItemRequestOptions	setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosBatch.
CosmosBatchItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
CosmosBatchItemRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Sets the throughput control group name.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosBatchItemRequestOptions

public CosmosBatchItemRequestOptions()

Creates a new CosmosBatchItemRequestOptions object.

Method Details

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.

setIfMatchETag

public CosmosBatchItemRequestOptions 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 CosmosBatchItemRequestOptions 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

setThroughputControlGroupName

public CosmosBatchItemRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Sets the throughput control group name.

Parameters:

throughputControlGroupName - the throughput control group name.

Returns:

the CosmosBatchItemRequestOptions.