com.microsoft.azure.cosmosdb

Class FeedOptionsBase

java.lang.Object

com.microsoft.azure.cosmosdb.FeedOptionsBase

Direct Known Subclasses:

ChangeFeedOptions, FeedOptions

public abstract class FeedOptionsBase
extends Object

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FeedOptionsBase()

Method Summary

Modifier and Type	Method and Description
Integer	getMaxItemCount() Gets the maximum number of items to be returned in the enumeration operation.
PartitionKey	getPartitionKey() Gets the partition key used to identify the current request's target partition.
String	getRequestContinuation() Gets the request continuation token.
void	setMaxItemCount(Integer maxItemCount) Sets the maximum number of items to be returned in the enumeration operation.
void	setPartitionKey(PartitionKey partitionkey) Sets the partition key used to identify the current request's target partition.
void	setRequestContinuation(String requestContinuation) Sets the request continuation token.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedOptionsBase

protected FeedOptionsBase()

Method Detail

getMaxItemCount

public Integer getMaxItemCount()

Gets the maximum number of items to be returned in the enumeration operation.

Returns:

the max number of items.

setMaxItemCount

public void setMaxItemCount(Integer maxItemCount)

Sets the maximum number of items to be returned in the enumeration operation.

Parameters:

maxItemCount - the max number of items.

getRequestContinuation

public String getRequestContinuation()

Gets the request continuation token.

Returns:

the request continuation.

setRequestContinuation

public void setRequestContinuation(String requestContinuation)

Sets the request continuation token.

Parameters:

requestContinuation - the request continuation.

getPartitionKey

public PartitionKey getPartitionKey()

Gets the partition key used to identify the current request's target partition.

Returns:

the partition key.

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.