CosmosBulkPatchItemRequestOptions
Encapsulates options that can be specified for an patch operation used in Bulk execution. It can be passed while
creating bulk patch request using BulkOperations
.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public final class BulkPatchItemRequestOptions extends Object
Constructor and Description |
---|
BulkPatchItemRequestOptions()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
String |
getFilterPredicate()
Deprecated.
|
String |
getIfMatchETag()
Deprecated.
|
String |
getIfNoneMatchETag()
Deprecated.
|
Boolean |
isContentResponseOnWriteEnabled()
Deprecated.
|
BulkPatchItemRequestOptions |
setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)
Deprecated.
|
void |
setContentResponseOnWriteEnabledCore(Boolean contentResponseOnWriteEnabled)
Deprecated.
|
BulkPatchItemRequestOptions |
setFilterPredicate(String filterPredicate)
Deprecated.
|
BulkPatchItemRequestOptions |
setIfMatchETag(String ifMatchETag)
Deprecated.
|
void |
setIfMatchETagCore(String ifMatchETag)
Deprecated.
|
BulkPatchItemRequestOptions |
setIfNoneMatchETag(String ifNoneMatchEtag)
Deprecated.
|
void |
setIfNoneMatchETagCore(String ifNoneMatchEtag)
Deprecated.
|
@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public String getFilterPredicate()
@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public BulkPatchItemRequestOptions setFilterPredicate(String filterPredicate)
setFilterPredicate("from c where c.taskNum = 3")
.filterPredicate
- the filterPredicate associated with the request.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public BulkPatchItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)
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.contentResponseOnWriteEnabled
- a boolean indicating whether payload will be included
in the response or not for this operation.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public BulkPatchItemRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)
CosmosItemOperation
.ifNoneMatchEtag
- the ifNoneMatchETag associated with the request.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public BulkPatchItemRequestOptions setIfMatchETag(String ifMatchETag)
CosmosItemOperation
.ifMatchETag
- the ifMatchETag associated with the request.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public String getIfMatchETag()
CosmosItemOperation
.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public void setIfMatchETagCore(String ifMatchETag)
CosmosItemOperation
.ifMatchETag
- the ifMatchETag associated with the request.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public String getIfNoneMatchETag()
CosmosItemOperation
.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public void setIfNoneMatchETagCore(String ifNoneMatchEtag)
CosmosItemOperation
.ifNoneMatchEtag
- the ifNoneMatchETag associated with the request.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public Boolean isContentResponseOnWriteEnabled()
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.@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") @Deprecated public void setContentResponseOnWriteEnabledCore(Boolean contentResponseOnWriteEnabled)
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.contentResponseOnWriteEnabled
- a boolean indicating whether payload will be included
in the response or not for this operation.Copyright © 2021 Microsoft Corporation. All rights reserved.