com.microsoft.azure.cosmosdb

Class FeedOptions

java.lang.Object

com.microsoft.azure.cosmosdb.FeedOptionsBase

com.microsoft.azure.cosmosdb.FeedOptions

public final class FeedOptions
extends FeedOptionsBase

Specifies the options associated with feed methods (enumeration operations) in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Constructor and Description
FeedOptions()
FeedOptions(FeedOptions options)

Method Summary

Modifier and Type	Method and Description
Boolean	getEmitVerboseTracesInQuery() Gets the option to allow queries to emit out verbose traces for investigation.
Boolean	getEnableCrossPartitionQuery() Gets the option to allow queries to run across all partitions of the collection.
Boolean	getEnableScanInQuery() Gets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.
int	getMaxBufferedItemCount() Gets the maximum number of items that can be buffered client side during parallel query execution.
int	getMaxDegreeOfParallelism() Gets the number of concurrent operations run client side during parallel query execution.
String	getPartitionKeyRangeIdInternal() Gets the partitionKeyRangeId.
String	getSessionToken() Gets the session token for use with session consistency.
void	setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery) Sets the option to allow queries to emit out verbose traces for investigation.
void	setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery) Sets the option to allow queries to run across all partitions of the collection.
void	setEnableScanInQuery(Boolean enableScanInQuery) Sets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.
void	setMaxBufferedItemCount(int maxBufferedItemCount) Sets the maximum number of items that can be buffered client side during parallel query execution.
void	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) Sets the number of concurrent operations run client side during parallel query execution.
void	setPartitionKeyRangeIdInternal(String partitionKeyRangeId) Sets the partitionKeyRangeId.
void	setSessionToken(String sessionToken) Sets the session token for use with session consistency.

Methods inherited from class com.microsoft.azure.cosmosdb.FeedOptionsBase

getMaxItemCount, getPartitionKey, getRequestContinuation, setMaxItemCount, setPartitionKey, setRequestContinuation

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedOptions

public FeedOptions()

FeedOptions

public FeedOptions(FeedOptions options)

Method Detail

getPartitionKeyRangeIdInternal

public String getPartitionKeyRangeIdInternal()

Gets the partitionKeyRangeId.

Returns:

the partitionKeyRangeId.

setPartitionKeyRangeIdInternal

public void setPartitionKeyRangeIdInternal(String partitionKeyRangeId)

Sets the partitionKeyRangeId.

Parameters:

partitionKeyRangeId - the partitionKeyRangeId.

getSessionToken

public String getSessionToken()

Gets the session token for use with session consistency.

Returns:

the session token.

setSessionToken

public void setSessionToken(String sessionToken)

Sets the session token for use with session consistency.

Parameters:

sessionToken - the session token.

getEnableScanInQuery

public Boolean getEnableScanInQuery()

Gets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.

Returns:

the option of enable scan in query.

setEnableScanInQuery

public void setEnableScanInQuery(Boolean enableScanInQuery)

Sets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.

Parameters:

enableScanInQuery - the option of enable scan in query.

getEmitVerboseTracesInQuery

public Boolean getEmitVerboseTracesInQuery()

Gets the option to allow queries to emit out verbose traces for investigation.

Returns:

the emit verbose traces in query.

setEmitVerboseTracesInQuery

public void setEmitVerboseTracesInQuery(Boolean emitVerboseTracesInQuery)

Sets the option to allow queries to emit out verbose traces for investigation.

Parameters:

emitVerboseTracesInQuery - the emit verbose traces in query.

getEnableCrossPartitionQuery

public Boolean getEnableCrossPartitionQuery()

Gets the option to allow queries to run across all partitions of the collection.

Returns:

whether to allow queries to run across all partitions of the collection.

setEnableCrossPartitionQuery

public void setEnableCrossPartitionQuery(Boolean enableCrossPartitionQuery)

Sets the option to allow queries to run across all partitions of the collection.

Parameters:

enableCrossPartitionQuery - whether to allow queries to run across all partitions of the collection.

getMaxDegreeOfParallelism

public int getMaxDegreeOfParallelism()

Gets the number of concurrent operations run client side during parallel query execution.

Returns:

number of concurrent operations run client side during parallel query execution.

setMaxDegreeOfParallelism

public void setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

Sets the number of concurrent operations run client side during parallel query execution.

Parameters:

maxDegreeOfParallelism - number of concurrent operations.

getMaxBufferedItemCount

public int getMaxBufferedItemCount()

Gets the maximum number of items that can be buffered client side during parallel query execution.

Returns:

maximum number of items that can be buffered client side during parallel query execution.

setMaxBufferedItemCount

public void setMaxBufferedItemCount(int maxBufferedItemCount)

Sets the maximum number of items that can be buffered client side during parallel query execution.

Parameters:

maxBufferedItemCount - maximum number of items.