Share via

ChangeFeedOptions Class

  • Reference
Package:
com.microsoft.azure.documentdb
  • java.lang.Object

public class ChangeFeedOptions extends FeedOptionsBase

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

Method Summary

Modifier and Type Method and Description
String getPartitionKeyRangeId()

Get the partition key range id for the current request

ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

boolean isStartFromBeginning()

Get whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).
void setPartitionKeyRangeId(String partitionKeyRangeId)

Set the partition key range id for the current request

ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

void setStartFromBeginning(boolean startFromBeginning)

Set whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).

Inherited Members

FeedOptionsBase.FeedOptionsBase() FeedOptionsBase.getPageSize() FeedOptionsBase.getRequestContinuation() FeedOptionsBase.setPageSize(Integer pageSize) FeedOptionsBase.setRequestContinuation(String requestContinuation)

Method Details

getPartitionKeyRangeId

public String getPartitionKeyRangeId()

Get the partition key range id for the current request

ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

Returns:

a string indicating the partition key range ID

isStartFromBeginning

public boolean isStartFromBeginning()

Get whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).

Returns:

a boolean value indicating change feed should start from beginning or not

setPartitionKeyRangeId

public void setPartitionKeyRangeId(String partitionKeyRangeId)

Set the partition key range id for the current request

ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

Parameters:

partitionKeyRangeId - a string indicating the partition key range ID

setStartFromBeginning

public void setStartFromBeginning(boolean startFromBeginning)

Set whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).

Parameters:

startFromBeginning - a boolean value indicating change feed should start from beginning or not

Applies to