Package com.azure.cosmos.models

Class CosmosBatchPatchItemRequestOptions

java.lang.Object
com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
public final class CosmosBatchPatchItemRequestOptions extends Object
Encapsulates options that can be specified for an operation within a CosmosBatch.

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

    • 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

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

    • 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

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

    • 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