com.azure.cosmos

Class ChangeFeedOptions

java.lang.Object

com.azure.cosmos.ChangeFeedOptions

public final class ChangeFeedOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ChangeFeedOptions()
ChangeFeedOptions(ChangeFeedOptions options)

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.
Map<String,Object>	getProperties() Gets the properties
String	getRequestContinuation() Gets the request continuation token.
OffsetDateTime	getStartDateTime() Gets the zoned date time to start looking for changes after.
boolean	getStartFromBeginning() Get whether change feed should start from beginning (true) or from current (false).
ChangeFeedOptions	setMaxItemCount(Integer maxItemCount) Sets the maximum number of items to be returned in the enumeration operation.
ChangeFeedOptions	setPartitionKey(PartitionKey partitionkey) Sets the partition key used to identify the current request's target partition.
ChangeFeedOptions	setProperties(Map<String,Object> properties) Sets the properties used to identify the request token.
ChangeFeedOptions	setRequestContinuation(String requestContinuation) Sets the request continuation token.
ChangeFeedOptions	setStartDateTime(OffsetDateTime startDateTime) Sets the zoned date time (exclusive) to start looking for changes after.
ChangeFeedOptions	setStartFromBeginning(boolean startFromBeginning) Set whether change feed should start from beginning (true) or from current (false).

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeFeedOptions

public ChangeFeedOptions()

ChangeFeedOptions

public ChangeFeedOptions(ChangeFeedOptions options)

Method Detail

getStartFromBeginning

public boolean getStartFromBeginning()

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

setStartFromBeginning

public ChangeFeedOptions 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

Returns:

the ChangeFeedOptions.

getStartDateTime

public OffsetDateTime getStartDateTime()

Gets the zoned date time to start looking for changes after.

Returns:

a zoned date time to start looking for changes after, if set or null otherwise

setStartDateTime

public ChangeFeedOptions setStartDateTime(OffsetDateTime startDateTime)

Sets the zoned date time (exclusive) to start looking for changes after. If this is specified, startFromBeginning is ignored.

Parameters:

startDateTime - a zoned date time to start looking for changes after.

Returns:

the ChangeFeedOptions.

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 ChangeFeedOptions setMaxItemCount(Integer maxItemCount)

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

Parameters:

maxItemCount - the max number of items.

Returns:

the FeedOptionsBase.

getRequestContinuation

public String getRequestContinuation()

Gets the request continuation token.

Returns:

the request continuation.

setRequestContinuation

public ChangeFeedOptions setRequestContinuation(String requestContinuation)

Sets the request continuation token.

Parameters:

requestContinuation - the request continuation.

Returns:

the FeedOptionsBase.

getPartitionKey

public PartitionKey getPartitionKey()

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

Returns:

the partition key.

setPartitionKey

public ChangeFeedOptions setPartitionKey(PartitionKey partitionkey)

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

Parameters:

partitionkey - the partition key value.

Returns:

the FeedOptionsBase.

getProperties

public Map<String,Object> getProperties()

Gets the properties

Returns:

Map of request options properties

setProperties

public ChangeFeedOptions setProperties(Map<String,Object> properties)

Sets the properties used to identify the request token.

Parameters:

properties - the properties.

Returns:

the FeedOptionsBase.