com.azure.cosmos.implementation.RequestOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-cosmos Show documentation
Show all versions of azure-cosmos Show documentation
This Package contains Microsoft Azure Cosmos SDK (with Reactive Extension Reactor support) for Azure Cosmos DB SQL API
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos.implementation;
import com.azure.cosmos.ConsistencyLevel;
import com.azure.cosmos.implementation.spark.OperationContextAndListenerTuple;
import com.azure.cosmos.models.DedicatedGatewayRequestOptions;
import com.azure.cosmos.models.IndexingDirective;
import com.azure.cosmos.models.PartitionKey;
import com.azure.cosmos.models.ThroughputProperties;
import java.time.Duration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Encapsulates options that can be specified for a request issued to the Azure Cosmos DB database service.
*/
public class RequestOptions {
private Map customOptions;
private List preTriggerInclude;
private List postTriggerInclude;
private IndexingDirective indexingDirective;
private ConsistencyLevel consistencyLevel;
private String sessionToken;
private Integer resourceTokenExpirySeconds;
private String offerType;
private String ifMatchETag;
private String ifNoneMatchETag;
private Integer offerThroughput;
private PartitionKey partitionkey;
private String partitionKeyRangeId;
private boolean scriptLoggingEnabled;
private boolean quotaInfoEnabled;
private Map properties;
private ThroughputProperties throughputProperties;
private Boolean contentResponseOnWriteEnabled;
private String filterPredicate;
private String throughputControlGroupName;
private OperationContextAndListenerTuple operationContextAndListenerTuple;
private DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions;
private Duration thresholdForDiagnosticsOnTracer;
/**
* Gets the triggers to be invoked before the operation.
*
* @return the triggers to be invoked before the operation.
*/
public List getPreTriggerInclude() {
return this.preTriggerInclude;
}
public OperationContextAndListenerTuple getOperationContextAndListenerTuple() {
return operationContextAndListenerTuple;
}
public void setOperationContextAndListenerTuple(OperationContextAndListenerTuple operationContextAndListenerTuple) {
this.operationContextAndListenerTuple = operationContextAndListenerTuple;
}
/**
* Sets the triggers to be invoked before the operation.
*
* @param preTriggerInclude the triggers to be invoked before the operation.
*/
public void setPreTriggerInclude(List preTriggerInclude) {
this.preTriggerInclude = preTriggerInclude;
}
/**
* Gets the triggers to be invoked after the operation.
*
* @return the triggers to be invoked after the operation.
*/
public List getPostTriggerInclude() {
return this.postTriggerInclude;
}
/**
* Sets the triggers to be invoked after the operation.
*
* @param postTriggerInclude the triggers to be invoked after the operation.
*/
public void setPostTriggerInclude(List postTriggerInclude) {
this.postTriggerInclude = postTriggerInclude;
}
/**
* Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
*
* @return tthe ifMatchETag associated with the request.
*/
public String getIfMatchETag() {
return this.ifMatchETag;
}
/**
* Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
*
* @param ifMatchETag the ifMatchETag associated with the request.
*/
public void setIfMatchETag(String ifMatchETag) {
this.ifMatchETag = ifMatchETag;
}
/**
* Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
*
* @return the ifNoneMatchETag associated with the request.
*/
public String getIfNoneMatchETag() {
return this.ifNoneMatchETag;
}
/**
* Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
*
* @param ifNoneMatchETag the ifNoneMatchETag associated with the request.
*/
public void setIfNoneMatchETag(String ifNoneMatchETag) {
this.ifNoneMatchETag = ifNoneMatchETag;
}
/**
* Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
*
* @return the FilterPredicate associated with the request.
*/
public String getFilterPredicate() {
return this.filterPredicate;
}
/**
* Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
*
* @param filterPredicate the filterPredicate associated with the request.
* @return the current request options
*/
public void setFilterPredicate(String filterPredicate) {
this.filterPredicate = filterPredicate;
}
/**
* Gets the indexing directive (index, do not index etc).
*
* @return the indexing directive.
*/
public IndexingDirective getIndexingDirective() {
return this.indexingDirective;
}
/**
* Sets the indexing directive (index, do not index etc).
*
* @param indexingDirective the indexing directive.
*/
public void setIndexingDirective(IndexingDirective indexingDirective) {
this.indexingDirective = indexingDirective;
}
/**
* Gets the consistency level required for the request.
*
* @return the consistency level.
*/
public ConsistencyLevel getConsistencyLevel() {
return this.consistencyLevel;
}
/**
* Sets the consistency level required for the request.
*
* @param consistencyLevel the consistency level.
*/
public void setConsistencyLevel(ConsistencyLevel consistencyLevel) {
this.consistencyLevel = consistencyLevel;
}
/**
* Gets the token for use with session consistency.
*
* @return the session token.
*/
public String getSessionToken() {
return this.sessionToken;
}
/**
* Sets the token for use with session consistency.
*
* @param sessionToken the session token.
*/
public void setSessionToken(String sessionToken) {
this.sessionToken = sessionToken;
}
/**
* Gets the expiry time for resource token. Used when creating, updating, reading permission.
*
* @return the resource token expiry seconds.
*/
public Integer getResourceTokenExpirySeconds() {
return this.resourceTokenExpirySeconds;
}
/**
* Sets the expiry time for resource token. Used when creating, updating, reading permission.
*
* @param resourceTokenExpirySeconds the resource token expiry seconds.
*/
public void setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds) {
this.resourceTokenExpirySeconds = resourceTokenExpirySeconds;
}
/**
* Gets the offer type when creating a container.
*
* @return the offer type.
*/
public String getOfferType() {
return this.offerType;
}
/**
* Sets the offer type when creating a container.
*
* @param offerType the offer type.
*/
public void setOfferType(String offerType) {
this.offerType = offerType;
}
/**
* Gets the throughput in the form of Request Units per second when creating a container.
*
* @return the throughput value.
*/
public Integer getOfferThroughput() {
return this.offerThroughput;
}
/**
* Sets the throughput in the form of Request Units per second when creating a container.
*
* @param offerThroughput the throughput value.
*/
public void setOfferThroughput(Integer offerThroughput) {
this.offerThroughput = offerThroughput;
}
public void setThroughputProperties(ThroughputProperties throughputProperties) {
this.throughputProperties = throughputProperties;
}
public ThroughputProperties getThroughputProperties() {
return this.throughputProperties;
}
/**
* Gets the partition key used to identify the current request's target partition.
*
* @return the partition key value.
*/
public PartitionKey getPartitionKey() {
return this.partitionkey;
}
/**
* Sets the partition key used to identify the current request's target partition.
*
* @param partitionkey the partition key value.
*/
public void setPartitionKey(PartitionKey partitionkey) {
this.partitionkey = partitionkey;
}
/**
* Internal usage only: Gets the partition key range id used to identify the current request's target partition.
*
* @return the partition key range id value.
*/
String getPartitionKeyRangeId() {
return this.partitionKeyRangeId;
}
/**
* Internal usage only: Sets the partition key range id used to identify the current request's target partition.
*
* @param partitionKeyRangeId the partition key range id value.
*/
protected void setPartitionKeyRengeId(String partitionKeyRangeId) {
this.partitionKeyRangeId = partitionKeyRangeId;
}
/**
* Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database
* service or not.
*
* @return true if Javascript stored procedure logging is enabled
*/
public boolean isScriptLoggingEnabled() {
return scriptLoggingEnabled;
}
/**
* Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database
* service or not.
*
* @param scriptLoggingEnabled true if stored procedure Javascript logging is enabled
*/
public void setScriptLoggingEnabled(boolean scriptLoggingEnabled) {
this.scriptLoggingEnabled = scriptLoggingEnabled;
}
/**
* Gets the quotaInfoEnabled setting for container read requests in the Azure Cosmos DB database service.
* quotaInfoEnabled is used to enable/disable getting container quota related stats for item
* container read requests.
*
* @return true if quotaInfoEnabled is enabled
*/
public boolean isQuotaInfoEnabled() {
return quotaInfoEnabled;
}
/**
* Sets the quotaInfoEnabled setting for container read requests in the Azure Cosmos DB database service.
* quotaInfoEnabled is used to enable/disable getting container quota related stats for item
* container read requests.
*
* @param quotaInfoEnabled a boolean value indicating whether quotaInfoEnabled is enabled or not
*/
public void setQuotaInfoEnabled(boolean quotaInfoEnabled) {
this.quotaInfoEnabled = quotaInfoEnabled;
}
/**
* Sets the custom request option value by key
*
* @param name a string representing the custom option's name
* @param value a STRING representing the custom option's value
*/
public void setHeader(String name, String value) {
if (this.customOptions == null) {
this.customOptions = new HashMap<>();
}
this.customOptions.put(name, value);
}
/**
* Gets the custom request options
*
* @return Map of custom request options
*/
public Map getHeaders() {
return this.customOptions;
}
/**
* Gets the properties
*
* @return Map of request options properties
*/
public Map getProperties() {
return properties;
}
/**
* Sets the properties used to identify the request token.
*
* @param properties the properties.
*/
public void setProperties(Map properties) {
this.properties = properties;
}
/**
* Gets the boolean to only return the headers and status code in Cosmos DB response
* in case of Create, Update and Delete operations on CosmosItem.
*
* 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 request.
*/
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 on CosmosItem.
*
* 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 on {@link com.azure.cosmos.models.CosmosItemRequestOptions},
* 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 request
*/
public void setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled) {
this.contentResponseOnWriteEnabled = contentResponseOnWriteEnabled;
}
public String getThroughputControlGroupName() {
return this.throughputControlGroupName;
}
public void setThroughputControlGroupName(String throughputControlGroupName) {
this.throughputControlGroupName = throughputControlGroupName;
}
public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions() {
return dedicatedGatewayRequestOptions;
}
public void setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) {
this.dedicatedGatewayRequestOptions = dedicatedGatewayRequestOptions;
}
/**
* Gets the thresholdForDiagnosticsOnTracer, if latency on CRUD operation is greater than this
* diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
*
* @return thresholdForDiagnosticsOnTracerInMS the latency threshold for diagnostics on tracer.
*/
public Duration getThresholdForDiagnosticsOnTracer() {
return thresholdForDiagnosticsOnTracer;
}
/**
* Sets the thresholdForDiagnosticsOnTracer, if latency on CRUD operation is greater than this
* diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
*
* @param thresholdForDiagnosticsOnTracer the latency threshold for diagnostics on tracer.
*/
public void setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) {
this.thresholdForDiagnosticsOnTracer = thresholdForDiagnosticsOnTracer;
}
}