RequestOptions (Async SDK for SQL API of Azure Cosmos DB Service 2.0.1 API)

java.lang.Object
- com.microsoft.azure.cosmosdb.RequestOptions

```
public class RequestOptions
extends Object
```
Encapsulates options that can be specified for a request issued to the Azure Cosmos DB database service.

Constructor Summary

Constructors
Constructor and Description

RequestOptions()

Constructors
Constructor and Description
`RequestOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessCondition`	`getAccessCondition()` Gets the conditions associated with the request.
`ConsistencyLevel`	`getConsistencyLevel()` Gets the consistency level required for the request.
`IndexingDirective`	`getIndexingDirective()` Gets the indexing directive (index, do not index etc).
`Integer`	`getOfferThroughput()` Gets the throughput in the form of Request Units per second when creating a document collection.
`String`	`getOfferType()` Gets the offer type when creating a document collection.
`PartitionKey`	`getPartitionKey()` Gets the partition key used to identify the current request's target partition.
`List<String>`	`getPostTriggerInclude()` Gets the triggers to be invoked after the operation.
`List<String>`	`getPreTriggerInclude()` Gets the triggers to be invoked before the operation.
`Integer`	`getResourceTokenExpirySeconds()` Gets the expiry time for resource token.
`String`	`getSessionToken()` Gets the token for use with session consistency.
`boolean`	`isPopulateQuotaInfo()` Gets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service.
`boolean`	`isScriptLoggingEnabled()` Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
`void`	`setAccessCondition(AccessCondition accessCondition)` Sets the conditions associated with the request.
`void`	`setConsistencyLevel(ConsistencyLevel consistencyLevel)` Sets the consistency level required for the request.
`void`	`setIndexingDirective(IndexingDirective indexingDirective)` Sets the indexing directive (index, do not index etc).
`void`	`setOfferThroughput(Integer offerThroughput)` Sets the throughput in the form of Request Units per second when creating a document collection.
`void`	`setOfferType(String offerType)` Sets the offer type when creating a document collection.
`void`	`setPartitionKey(PartitionKey partitionkey)` Sets the partition key used to identify the current request's target partition.
`protected void`	`setPartitionKeyRengeId(String partitionKeyRangeId)` Internal usage only: Sets the partition key range id used to identify the current request's target partition.
`void`	`setPopulateQuotaInfo(boolean populateQuotaInfo)` Sets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service.
`void`	`setPostTriggerInclude(List<String> postTriggerInclude)` Sets the triggers to be invoked after the operation.
`void`	`setPreTriggerInclude(List<String> preTriggerInclude)` Sets the triggers to be invoked before the operation.
`void`	`setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)` Sets the expiry time for resource token.
`void`	`setScriptLoggingEnabled(boolean scriptLoggingEnabled)` Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
`void`	`setSessionToken(String sessionToken)` Sets the token for use with session consistency.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RequestOptions
```
public RequestOptions()
```
- Method Detail
  - getPreTriggerInclude
```
public List<String> getPreTriggerInclude()
```
    Gets the triggers to be invoked before the operation.
    
    Returns:
    
    the triggers to be invoked before the operation.
  - setPreTriggerInclude
```
public void setPreTriggerInclude(List<String> preTriggerInclude)
```
    Sets the triggers to be invoked before the operation.
    
    Parameters:
    
    preTriggerInclude - the triggers to be invoked before the operation.
  - getPostTriggerInclude
```
public List<String> getPostTriggerInclude()
```
    Gets the triggers to be invoked after the operation.
    
    Returns:
    
    the triggers to be invoked after the operation.
  - setPostTriggerInclude
```
public void setPostTriggerInclude(List<String> postTriggerInclude)
```
    Sets the triggers to be invoked after the operation.
    
    Parameters:
    
    postTriggerInclude - the triggers to be invoked after the operation.
  - getAccessCondition
```
public AccessCondition getAccessCondition()
```
    Gets the conditions associated with the request.
    
    Returns:
    
    the access condition.
  - setAccessCondition
```
public void setAccessCondition(AccessCondition accessCondition)
```
    Sets the conditions associated with the request.
    
    Parameters:
    
    accessCondition - the access condition.
  - getIndexingDirective
```
public IndexingDirective getIndexingDirective()
```
    Gets the indexing directive (index, do not index etc).
    
    Returns:
    
    the indexing directive.
  - setIndexingDirective
```
public void setIndexingDirective(IndexingDirective indexingDirective)
```
    Sets the indexing directive (index, do not index etc).
    
    Parameters:
    
    indexingDirective - the indexing directive.
  - getConsistencyLevel
```
public ConsistencyLevel getConsistencyLevel()
```
    Gets the consistency level required for the request.
    
    Returns:
    
    the consistency level.
  - setConsistencyLevel
```
public void setConsistencyLevel(ConsistencyLevel consistencyLevel)
```
    Sets the consistency level required for the request.
    
    Parameters:
    
    consistencyLevel - the consistency level.
  - getSessionToken
```
public String getSessionToken()
```
    Gets the token for use with session consistency.
    
    Returns:
    
    the session token.
  - setSessionToken
```
public void setSessionToken(String sessionToken)
```
    Sets the token for use with session consistency.
    
    Parameters:
    
    sessionToken - the session token.
  - getResourceTokenExpirySeconds
```
public Integer getResourceTokenExpirySeconds()
```
    Gets the expiry time for resource token. Used when creating, updating, reading permission.
    
    Returns:
    
    the resource token expiry seconds.
  - setResourceTokenExpirySeconds
```
public void setResourceTokenExpirySeconds(Integer resourceTokenExpirySeconds)
```
    Sets the expiry time for resource token. Used when creating, updating, reading permission.
    
    Parameters:
    
    resourceTokenExpirySeconds - the resource token expiry seconds.
  - getOfferType
```
public String getOfferType()
```
    Gets the offer type when creating a document collection.
    
    Returns:
    
    the offer type.
  - setOfferType
```
public void setOfferType(String offerType)
```
    Sets the offer type when creating a document collection.
    
    Parameters:
    
    offerType - the offer type.
  - getOfferThroughput
```
public Integer getOfferThroughput()
```
    Gets the throughput in the form of Request Units per second when creating a document collection.
    
    Returns:
    
    the throughput value.
  - setOfferThroughput
```
public void setOfferThroughput(Integer offerThroughput)
```
    Sets the throughput in the form of Request Units per second when creating a document collection.
    
    Parameters:
    
    offerThroughput - the throughput value.
  - getPartitionKey
```
public PartitionKey getPartitionKey()
```
    Gets the partition key used to identify the current request's target partition.
    
    Returns:
    
    the partition key value.
  - setPartitionKey
```
public void setPartitionKey(PartitionKey partitionkey)
```
    Sets the partition key used to identify the current request's target partition.
    
    Parameters:
    
    partitionkey - the partition key value.
  - setPartitionKeyRengeId
```
protected void setPartitionKeyRengeId(String partitionKeyRangeId)
```
    Internal usage only: Sets the partition key range id used to identify the current request's target partition.
    
    Parameters:
    
    partitionKeyRangeId - the partition key range id value.
  - isScriptLoggingEnabled
```
public boolean isScriptLoggingEnabled()
```
    Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
    
    Returns:
    
    true if Javascript stored procedure logging is enabled
  - setScriptLoggingEnabled
```
public void setScriptLoggingEnabled(boolean scriptLoggingEnabled)
```
    Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
    
    Parameters:
    
    scriptLoggingEnabled - true if stored procedure Javascript logging is enabled
  - isPopulateQuotaInfo
```
public boolean isPopulateQuotaInfo()
```
    Gets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting document collection quota related stats for document collection read requests.
    
    Returns:
    
    true if PopulateQuotaInfo is enabled
  - setPopulateQuotaInfo
```
public void setPopulateQuotaInfo(boolean populateQuotaInfo)
```
    Sets the PopulateQuotaInfo setting for document collection read requests in the Azure Cosmos DB database service. PopulateQuotaInfo is used to enable/disable getting document collection quota related stats for document collection read requests.
    
    Parameters:
    
    populateQuotaInfo - a boolean value indicating whether PopulateQuotaInfo is enabled or not

Class RequestOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestOptions

Method Detail

getPreTriggerInclude

setPreTriggerInclude

getPostTriggerInclude

setPostTriggerInclude

getAccessCondition

setAccessCondition

getIndexingDirective

setIndexingDirective

getConsistencyLevel

setConsistencyLevel

getSessionToken

setSessionToken

getResourceTokenExpirySeconds

setResourceTokenExpirySeconds

getOfferType

setOfferType

getOfferThroughput

setOfferThroughput

getPartitionKey

setPartitionKey

setPartitionKeyRengeId

isScriptLoggingEnabled

setScriptLoggingEnabled

isPopulateQuotaInfo

setPopulateQuotaInfo