Package com.azure.cosmos.models

Class CosmosBulkPatchItemRequestOptions

  • public final class CosmosBulkPatchItemRequestOptions
extends Object
    Encapsulates options that can be specified for an patch operation used in Bulk execution. It can be passed while creating bulk patch request using CosmosBulkOperations.

    • Constructor Detail

      • CosmosBulkPatchItemRequestOptions

        public CosmosBulkPatchItemRequestOptions()
        Constructor

    • Method Detail

      • getFilterPredicate

        public String getFilterPredicate()
        Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
        Returns:
        the FilterPredicate associated with the request.

      • setFilterPredicate

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

      • 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 CosmosBulkPatchItemRequestOptions 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.

      • getIfNoneMatchETag

        public String getIfNoneMatchETag()
        Gets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
        Returns:
        the ifNoneMatchETag associated with the request.

      • setIfNoneMatchETag

        public CosmosBulkPatchItemRequestOptions setIfNoneMatchETag​(String ifNoneMatchEtag)
        Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
        Parameters:
        ifNoneMatchEtag - the ifNoneMatchETag associated with the request.
        Returns:
        the current request options.

      • getIfMatchETag

        public String getIfMatchETag()
        Gets the If-Match (ETag) associated with the operation in CosmosItemOperation.
        Returns:
        ifMatchETag the ifMatchETag associated with the request.