CosmosPatchItemRequestOptions Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.80.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosItemRequestOptions
  • • com.azure.cosmos.models.CosmosPatchItemRequestOptions

public class CosmosPatchItemRequestOptions
extends CosmosItemRequestOptions

Encapsulates options for CosmosPatchOperations

Constructor Summary

Constructor	Description
CosmosPatchItemRequestOptions()	Constructor

Method Summary

Modifier and Type	Method and Description
String	getFilterPredicate() Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
CosmosPatchItemRequestOptions	setFilterPredicate(String filterPredicate) Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.

Methods inherited from CosmosItemRequestOptions

getAdditionalHeaders getConsistencyLevel getCustomItemSerializer getDedicatedGatewayRequestOptions getDiagnosticsThresholds getExcludedRegions getIfMatchETag getIfNoneMatchETag getIndexingDirective getKeywordIdentifiers getPostTriggerInclude getPreTriggerInclude getReadConsistencyStrategy getSessionToken getThresholdForDiagnosticsOnTracer getThroughputControlGroupName isContentResponseOnWriteEnabled setAdditionalHeaders setConsistencyLevel setContentResponseOnWriteEnabled setCosmosEndToEndOperationLatencyPolicyConfig setCustomItemSerializer setDedicatedGatewayRequestOptions setDiagnosticsThresholds setExcludedRegions setIfMatchETag setIfNoneMatchETag setIndexingDirective setKeywordIdentifiers setNonIdempotentWriteRetryPolicy setPostTriggerInclude setPreTriggerInclude setReadConsistencyStrategy setSessionToken setThresholdForDiagnosticsOnTracer setThroughputControlGroupName

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosPatchItemRequestOptions

public CosmosPatchItemRequestOptions()

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 CosmosPatchItemRequestOptions 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