Share via

FeedOptionsBase Class

  • Reference
Package:
com.microsoft.azure.cosmosdb
  • java.lang.Object
    • com.microsoft.azure.cosmosdb.FeedOptionsBase

public class FeedOptionsBase

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

Constructor Summary

Constructor Description
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.
boolean getPopulateQueryMetrics()

Gets the option to enable populate query metrics

Map<String, Object> getProperties()

Gets the properties
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 setPopulateQueryMetrics(boolean populateQueryMetrics)

Sets the option to enable/disable getting metrics relating to query execution on document query requests

void setProperties(Map<String, Object> properties)

Sets the properties used to identify the request token.
void setRequestContinuation(String requestContinuation)

Sets the request continuation token.

Constructor Details

FeedOptionsBase

protected FeedOptionsBase()

Method Details

getMaxItemCount

public Integer getMaxItemCount()

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

Returns:

the max number of items.

getPartitionKey

public PartitionKey getPartitionKey()

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

Returns:

the partition key.

getPopulateQueryMetrics

public boolean getPopulateQueryMetrics()

Gets the option to enable populate query metrics

Returns:

whether to enable populate query metrics

getProperties

public Map getProperties()

Gets the properties

Returns:

Map of request options properties

getRequestContinuation

public String getRequestContinuation()

Gets the request continuation token.

Returns:

the request continuation.

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.

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.

setPopulateQueryMetrics

public void setPopulateQueryMetrics(boolean populateQueryMetrics)

Sets the option to enable/disable getting metrics relating to query execution on document query requests

Parameters:

populateQueryMetrics - whether to enable or disable query metrics

setProperties

public void setProperties(Map properties)

Sets the properties used to identify the request token.

Parameters:

properties - the properties.

setRequestContinuation

public void setRequestContinuation(String requestContinuation)

Sets the request continuation token.

Parameters:

requestContinuation - the request continuation.

Applies to