com.azure.cosmos.models

Class CosmosItemRequestOptions

java.lang.Object

com.azure.cosmos.models.CosmosItemRequestOptions

public class CosmosItemRequestOptions
extends Object

Encapsulates options that can be specified for a request issued to cosmos Item.

Constructor Summary

Constructors

Constructor and Description
CosmosItemRequestOptions() Constructor

Method Summary

Modifier and Type	Method and Description
String	getIfMatchETag() Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
String	getIfNoneMatchETag() Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
IndexingDirective	getIndexingDirective() Gets the indexing directive (index, do not index etc).
List<String>	getPostTriggerInclude() Gets the triggers to be invoked after the operation.
List<String>	getPreTriggerInclude() Gets the triggers to be invoked before the operation.
String	getSessionToken() Gets the token for use with session consistency.
CosmosItemRequestOptions	setIfMatchETag(String ifMatchETag) Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchETag) Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
CosmosItemRequestOptions	setIndexingDirective(IndexingDirective indexingDirective) Sets the indexing directive (index, do not index etc).
CosmosItemRequestOptions	setPostTriggerInclude(List<String> postTriggerInclude) Sets the triggers to be invoked after the operation.
CosmosItemRequestOptions	setPreTriggerInclude(List<String> preTriggerInclude) Sets the triggers to be invoked before the operation.
CosmosItemRequestOptions	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

CosmosItemRequestOptions

public CosmosItemRequestOptions()

Constructor

Method Detail

getIfMatchETag

public String getIfMatchETag()

Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.

Returns:

the ifMatchETag associated with the request.

setIfMatchETag

public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag)

Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.

Parameters:

ifMatchETag - the ifMatchETag associated with the request.

Returns:

the current request options

getIfNoneMatchETag

public String getIfNoneMatchETag()

Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.

Returns:

the ifNoneMatchETag associated with the request.

setIfNoneMatchETag

public CosmosItemRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)

Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.

Parameters:

ifNoneMatchETag - the ifNoneMatchETag associated with the request.

Returns:

the current request options

getIndexingDirective

public IndexingDirective getIndexingDirective()

Gets the indexing directive (index, do not index etc).

Returns:

the indexing directive.

setIndexingDirective

public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)

Sets the indexing directive (index, do not index etc).

Parameters:

indexingDirective - the indexing directive.

Returns:

the CosmosItemRequestOptions.

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 CosmosItemRequestOptions setPreTriggerInclude(List<String> preTriggerInclude)

Sets the triggers to be invoked before the operation.

Parameters:

preTriggerInclude - the triggers to be invoked before the operation.

Returns:

the CosmosItemRequestOptions.

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 CosmosItemRequestOptions setPostTriggerInclude(List<String> postTriggerInclude)

Sets the triggers to be invoked after the operation.

Parameters:

postTriggerInclude - the triggers to be invoked after the operation.

Returns:

the CosmosItemRequestOptions.

getSessionToken

public String getSessionToken()

Gets the token for use with session consistency.

Returns:

the session token.

setSessionToken

public CosmosItemRequestOptions setSessionToken(String sessionToken)

Sets the token for use with session consistency.

Parameters:

sessionToken - the session token.

Returns:

the CosmosItemRequestOptions.