Freigeben über

CosmosBulkItemRequestOptions Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.66.0
  • java.lang.Object
    • com.azure.cosmos.models.CosmosBulkItemRequestOptions

public final class CosmosBulkItemRequestOptions

Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while creating bulk request using CosmosBulkOperations.

Constructor Summary

Constructor Description
CosmosBulkItemRequestOptions()

Constructor

Method Summary

Modifier and Type Method and Description
String getIfMatchETag()

Gets the If-Match (ETag) associated with the operation in CosmosItemOperation.
String getIfNoneMatchETag()

Gets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
Boolean isContentResponseOnWriteEnabled()

Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in CosmosItemOperation.
CosmosBulkItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)

Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in CosmosItemOperation.
CosmosBulkItemRequestOptions setIfMatchETag(String ifMatchETag)

Sets the If-Match (ETag) associated with the operation in CosmosItemOperation.
CosmosBulkItemRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)

Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosBulkItemRequestOptions

public CosmosBulkItemRequestOptions()

Constructor

Method Details

getIfMatchETag

public String getIfMatchETag()

Gets the If-Match (ETag) associated with the operation in CosmosItemOperation. 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 CosmosItemOperation. 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.

isContentResponseOnWriteEnabled

public Boolean isContentResponseOnWriteEnabled()

Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in CosmosItemOperation. If set to false, service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network and serializing it on the client. This feature does not impact RU usage for read or write operations. By-default, this is null.

Returns:

a boolean indicating whether payload will be included in the response or not for this operation.

setContentResponseOnWriteEnabled

public CosmosBulkItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)

Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in CosmosItemOperation. If set to false, service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network and serializing it on the client. This feature does not impact RU usage for read or write operations. By-default, this is null. NOTE: This flag is also present on CosmosClientBuilder, however if specified here, it will override the value specified in CosmosClientBuilder for this request.

Parameters:

contentResponseOnWriteEnabled - a boolean indicating whether payload will be included in the response or not for this operation.

Returns:

the current request options.

setIfMatchETag

public CosmosBulkItemRequestOptions setIfMatchETag(String ifMatchETag)

Sets the If-Match (ETag) associated with the operation in CosmosItemOperation. 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 CosmosBulkItemRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)

Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation. 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.

Applies to