Conditional Patch SDK

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BridgeInternal.java

@@ -795,6 +795,11 @@ public static List<PatchOperation> getPatchOperationsFromCosmosPatch(CosmosPatch
         return cosmosPatchOperations.getPatchOperations();
     }
 
+    @Warning(value = INTERNAL_USE_ONLY_WARNING)
+    public static int getPayloadLength(TransactionalBatchResponse transactionalBatchResponse) {
+        return transactionalBatchResponse.getResponseLength();
+    }
+
     @Warning(value = INTERNAL_USE_ONLY_WARNING)
     public static SqlQuerySpec getOfferQuerySpecFromResourceId(CosmosAsyncContainer container, String resourceId) {
         return container.getDatabase().getOfferQuerySpecFromResourceId(resourceId);

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BulkItemRequestOptions.java

@@ -3,29 +3,14 @@
 
 package com.azure.cosmos;
 
-import com.azure.cosmos.implementation.RequestOptions;
 import com.azure.cosmos.util.Beta;
 
 /**
  * Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while
  * creating bulk request using {@link BulkOperations}.
  */
 @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
-public final class BulkItemRequestOptions {
-
-    private String ifMatchETag;
-    private String ifNoneMatchETag;
-    private Boolean contentResponseOnWriteEnabled;
-
-    /**
-     * Gets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}.
-     *
-     * @return ifMatchETag the ifMatchETag associated with the request.
-     */
-    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
-    public String getIfMatchETag() {
-        return this.ifMatchETag;
-    }
+public final class BulkItemRequestOptions extends BulkItemRequestOptionsBase {
 
     /**
      * Sets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}.
@@ -35,20 +20,10 @@ public String getIfMatchETag() {
      */
     @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public BulkItemRequestOptions setIfMatchETag(final String ifMatchETag) {
-        this.ifMatchETag = ifMatchETag;
+        setIfMatchETagCore(ifMatchETag);
         return this;
     }
 
-    /**
-     * Gets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}.
-     *
-     * @return the ifNoneMatchETag associated with the request.
-     */
-    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
-    public String getIfNoneMatchETag() {
-        return this.ifNoneMatchETag;
-    }
-
     /**
      * Sets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}.
      *
@@ -57,28 +32,10 @@ public String getIfNoneMatchETag() {
      */
     @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public BulkItemRequestOptions setIfNoneMatchETag(final String ifNoneMatchEtag) {
-        this.ifNoneMatchETag = ifNoneMatchEtag;
+        setIfNoneMatchETagCore(ifNoneMatchETag);
         return this;
     }
 
-    /**
-     * Gets the boolean to only return the headers and status code in Cosmos DB response
-     * in case of Create, Update and Delete operations in {@link 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.
-     *
-     * @return a boolean indicating whether payload will be included in the response or not for this operation.
-     */
-    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
-    public Boolean isContentResponseOnWriteEnabled() {
-        return 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 {@link CosmosItemOperation}.
@@ -100,15 +57,7 @@ public Boolean isContentResponseOnWriteEnabled() {
      */
     @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
     public BulkItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled) {
-        this.contentResponseOnWriteEnabled = contentResponseOnWriteEnabled;
+        setContentResponseOnWriteEnabledCore(contentResponseOnWriteEnabled);
         return this;
     }
-
-    RequestOptions toRequestOptions() {
-        final RequestOptions requestOptions = new RequestOptions();
-        requestOptions.setIfMatchETag(getIfMatchETag());
-        requestOptions.setIfNoneMatchETag(getIfNoneMatchETag());
-        requestOptions.setContentResponseOnWriteEnabled(isContentResponseOnWriteEnabled());
-        return requestOptions;
-    }
 }

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BulkItemRequestOptionsBase.java

@@ -0,0 +1,114 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.cosmos;
+
+import com.azure.cosmos.implementation.RequestOptions;
+import com.azure.cosmos.util.Beta;
+
+/**
+ * Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while
+ * creating bulk request using {@link BulkOperations}.
+ */
+@Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+public class BulkItemRequestOptionsBase {
+
+    protected String ifMatchETag;
+    protected String ifNoneMatchETag;
+    protected Boolean contentResponseOnWriteEnabled;
+
+    /**
+     * Gets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}.
+     *
+     * @return ifMatchETag the ifMatchETag associated with the request.
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public String getIfMatchETag() {
+        return this.ifMatchETag;
+    }
+
+    /**
+     * Sets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}.
+     *
+     * @param ifMatchETag the ifMatchETag associated with the request.
+     * @return the current request options
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public void setIfMatchETagCore(final String ifMatchETag){
+        this.ifMatchETag = ifMatchETag;
+        return;
+    }
+
+    /**
+     * Gets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}.
+     *
+     * @return the ifNoneMatchETag associated with the request.
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public String getIfNoneMatchETag() {
+        return this.ifNoneMatchETag;
+    }
+
+    /**
+     * Sets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}.
+     *
+     * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request.
+     * @return the current request options.
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public void setIfNoneMatchETagCore(final String ifNoneMatchEtag){
+        this.ifNoneMatchETag = ifNoneMatchEtag;
+        return;
+    }
+
+    /**
+     * Gets the boolean to only return the headers and status code in Cosmos DB response
+     * in case of Create, Update and Delete operations in {@link 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.
+     *
+     * @return a boolean indicating whether payload will be included in the response or not for this operation.
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public Boolean isContentResponseOnWriteEnabled() {
+        return 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 {@link 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 {@link com.azure.cosmos.CosmosClientBuilder}, however if specified
+     * here, it will override the value specified in {@link com.azure.cosmos.CosmosClientBuilder} for this request.
+     *
+     * @param contentResponseOnWriteEnabled a boolean indicating whether payload will be included
+     * in the response or not for this operation.
+     *
+     * @return the current request options.
+     */
+    @Beta(value = Beta.SinceVersion.V4_9_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public void setContentResponseOnWriteEnabledCore(Boolean contentResponseOnWriteEnabled){
+        this.contentResponseOnWriteEnabled = contentResponseOnWriteEnabled;
+        return;
+    }
+
+    RequestOptions toRequestOptions() {
+        final RequestOptions requestOptions = new RequestOptions();
+        requestOptions.setIfMatchETag(getIfMatchETag());
+        requestOptions.setIfNoneMatchETag(getIfNoneMatchETag());
+        requestOptions.setContentResponseOnWriteEnabled(isContentResponseOnWriteEnabled());
+        return requestOptions;
+    }
+}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BulkOperations.java

@@ -259,7 +259,7 @@ public static <T> CosmosItemOperation getUpsertItemOperation(
 
         checkNotNull(item, "expected non-null item");
         checkNotNull(partitionKey, "expected non-null partitionKey");
-        
+
         if (requestOptions == null) {
             requestOptions = new BulkItemRequestOptions();
         }
@@ -292,7 +292,7 @@ public static CosmosItemOperation getPatchItemOperation(
         checkNotNull(partitionKey, "expected non-null partitionKey");
         checkNotNull(cosmosPatchOperations, "expected non-null cosmosPatchOperations");
 
-        return getPatchItemOperation(id, partitionKey, cosmosPatchOperations, new BulkItemRequestOptions());
+        return getPatchItemOperation(id, partitionKey, cosmosPatchOperations, new BulkPatchItemRequestOptions());
     }
 
     /**
@@ -310,14 +310,14 @@ public static CosmosItemOperation getPatchItemOperation(
         String id,
         PartitionKey partitionKey,
         CosmosPatchOperations cosmosPatchOperations,
-        BulkItemRequestOptions requestOptions) {
+        BulkPatchItemRequestOptions requestOptions) {
 
         checkNotNull(id, "expected non-null id");
         checkNotNull(partitionKey, "expected non-null partitionKey");
         checkNotNull(cosmosPatchOperations, "expected non-null cosmosPatchOperations");
 
         if (requestOptions == null) {
-            requestOptions = new BulkItemRequestOptions();
+            requestOptions = new BulkPatchItemRequestOptions();
         }
 
         return new ItemBulkOperation<>(

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/BulkPatchItemRequestOptions.java

@@ -0,0 +1,93 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.cosmos;
+
+import com.azure.cosmos.implementation.RequestOptions;
+import com.azure.cosmos.util.Beta;
+
+/**
+ * Encapsulates options that can be specified for an patch operation used in Bulk execution. It can be passed while
+ * creating bulk patch request using {@link BulkOperations}.
+ */
+@Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+public final class BulkPatchItemRequestOptions extends BulkItemRequestOptionsBase {
+    private String filterPredicate;
+
+    /**
+     * Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
+     *
+     * @return the FilterPredicate associated with the request.
+     */
+    @Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public String getFilterPredicate() {
+        return this.filterPredicate;
+    }
+
+    /**
+     * Sets the FilterPredicate associated with the request in the Azure Cosmos DB service. for example: {@code setFilterPredicate("from c where c.taskNum = 3")}.
+     *
+     * @param filterPredicate the filterPredicate associated with the request.
+     * @return the current request options
+     */
+    @Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public BulkPatchItemRequestOptions setFilterPredicate(String filterPredicate) {
+        this.filterPredicate = filterPredicate;
+        return this;
+    }
+
+    /**
+     * Sets the boolean to only return the headers and status code in Cosmos DB response
+     * in case of Create, Update and Delete operations in {@link 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 {@link com.azure.cosmos.CosmosClientBuilder}, however if specified
+     * here, it will override the value specified in {@link com.azure.cosmos.CosmosClientBuilder} for this request.
+     *
+     * @param contentResponseOnWriteEnabled a boolean indicating whether payload will be included
+     * in the response or not for this operation.
+     *
+     * @return the current request options.
+     */
+    @Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public BulkPatchItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled) {
+        setContentResponseOnWriteEnabledCore(contentResponseOnWriteEnabled);
+        return this;
+    }
+
+    /**
+     * Sets the If-None-Match (ETag) associated with the request in operation in {@link CosmosItemOperation}.
+     *
+     * @param ifNoneMatchEtag the ifNoneMatchETag associated with the request.
+     * @return the current request options.
+     */
+    @Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public BulkPatchItemRequestOptions setIfNoneMatchETag(final String ifNoneMatchEtag) {
+        setIfNoneMatchETagCore(ifNoneMatchEtag);
+        return this;
+    }
+
+    /**
+     * Sets the If-Match (ETag) associated with the operation in {@link CosmosItemOperation}.
+     *
+     * @param ifMatchETag the ifMatchETag associated with the request.
+     * @return the current request options
+     */
+    @Beta(value = Beta.SinceVersion.V4_13_0, warningText = Beta.PREVIEW_SUBJECT_TO_CHANGE_WARNING)
+    public BulkPatchItemRequestOptions setIfMatchETag(final String ifMatchETag) {
+        setIfMatchETagCore(ifMatchETag);
+        return this;
+    }
+
+    RequestOptions toRequestOptions() {
+        final RequestOptions requestOptions = super.toRequestOptions();
+        requestOptions.setFilterPredicate(getFilterPredicate());
+        return requestOptions;
+    }
+}