com.azure.cosmos

Class BulkPatchItemRequestOptions

java.lang.Object

com.azure.cosmos.BulkPatchItemRequestOptions

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class BulkPatchItemRequestOptions
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 BulkOperations.

Constructor Summary

Constructors

Constructor and Description
BulkPatchItemRequestOptions()

Method Summary

Modifier and Type	Method and Description
String	getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
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.
BulkPatchItemRequestOptions	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.
void	setContentResponseOnWriteEnabledCore(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.
BulkPatchItemRequestOptions	setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
BulkPatchItemRequestOptions	setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosItemOperation.
void	setIfMatchETagCore(String ifMatchETag) Sets the If-Match (ETag) associated with the operation in CosmosItemOperation.
BulkPatchItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.
void	setIfNoneMatchETagCore(String ifNoneMatchEtag) Sets the If-None-Match (ETag) associated with the request in operation in CosmosItemOperation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkPatchItemRequestOptions

public BulkPatchItemRequestOptions()

Method Detail

getFilterPredicate

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getFilterPredicate()

Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.

Returns:

the FilterPredicate associated with the request.

setFilterPredicate

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkPatchItemRequestOptions 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

setContentResponseOnWriteEnabled

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkPatchItemRequestOptions 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.

setIfNoneMatchETag

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkPatchItemRequestOptions 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.

setIfMatchETag

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public BulkPatchItemRequestOptions setIfMatchETag(String ifMatchETag)

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

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

Returns:

the current request options

getIfMatchETag

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getIfMatchETag()

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

Returns:

ifMatchETag the ifMatchETag associated with the request.

setIfMatchETagCore

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void setIfMatchETagCore(String ifMatchETag)

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

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

getIfNoneMatchETag

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public String getIfNoneMatchETag()

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

Returns:

the ifNoneMatchETag associated with the request.

setIfNoneMatchETagCore

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void setIfNoneMatchETagCore(String ifNoneMatchEtag)

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

Parameters:

ifNoneMatchEtag - the ifNoneMatchETag associated with the request.

isContentResponseOnWriteEnabled

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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.

setContentResponseOnWriteEnabledCore

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public void setContentResponseOnWriteEnabledCore(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.