com.azure.cosmos.models.CosmosChangeFeedRequestOptions.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions"
fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions"
name: "CosmosChangeFeedRequestOptions"
nameWithType: "CosmosChangeFeedRequestOptions"
summary: "Encapsulates options that can be specified for an operation within a change feed request."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CosmosChangeFeedRequestOptions**"
methods:
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.allVersionsAndDeletes()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.allVersionsAndDeletes()"
  name: "allVersionsAndDeletes()"
  nameWithType: "CosmosChangeFeedRequestOptions.allVersionsAndDeletes()"
  summary: "Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates."
  syntax: "public CosmosChangeFeedRequestOptions allVersionsAndDeletes()"
  desc: "Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates. Enabling AllVersionsAndDeletes change feed mode requires configuring a retention duration in the change feed policy of the container. <xref uid=\"com.azure.cosmos.models.ChangeFeedPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedPolicy\"></xref>\n\nIntermediary snapshots of changes as well as deleted documents would be available for processing for 8 minutes before they vanish. When enabling AllVersionsAndDeletes mode you will only be able to process change feed events within the retention window configured in the change feed policy of the container. If you attempt to process a change feed after more than the retention window an error (Status Code 400) will be returned because the events for intermediary updates and deletes have vanished. It would still be possible to process changes using LatestVersion mode even when configuring a AllVersionsAndDeletes change feed policy with retention window on the container and when using LatestVersion mode it doesn't matter whether your are out of the retention window or not - but no events for deletes or intermediary updates would be included. When events are not getting processed within the retention window it is also possible to continue processing future events in AllVersionsAndDeletes mode by querying the change feed with a new CosmosChangeFeedRequestOptions instance."
  returns:
    description: "a <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance with AllVersionsAndDeletes mode enabled"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromBeginning(com.azure.cosmos.models.FeedRange)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromBeginning(FeedRange feedRange)"
  name: "createForProcessingFromBeginning(FeedRange feedRange)"
  nameWithType: "CosmosChangeFeedRequestOptions.createForProcessingFromBeginning(FeedRange feedRange)"
  summary: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from the beginning of the change feed"
  modifiers:
  - "static"
  parameters:
  - description: "The <xref uid=\"com.azure.cosmos.models.FeedRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeedRange\"></xref> that is used to define the scope (entire container,\n                  logical partition or subset of a container)"
    name: "feedRange"
    type: "<xref href=\"com.azure.cosmos.models.FeedRange?alt=com.azure.cosmos.models.FeedRange&text=FeedRange\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)"
  desc: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from the beginning of the change feed"
  returns:
    description: "a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromContinuation(java.lang.String)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromContinuation(String continuation)"
  name: "createForProcessingFromContinuation(String continuation)"
  nameWithType: "CosmosChangeFeedRequestOptions.createForProcessingFromContinuation(String continuation)"
  summary: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from a previous continuation"
  modifiers:
  - "static"
  parameters:
  - description: "The continuation that was retrieved from a previously retrieved\n                     FeedResponse"
    name: "continuation"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)"
  desc: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from a previous continuation"
  returns:
    description: "a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromNow(com.azure.cosmos.models.FeedRange)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromNow(FeedRange feedRange)"
  name: "createForProcessingFromNow(FeedRange feedRange)"
  nameWithType: "CosmosChangeFeedRequestOptions.createForProcessingFromNow(FeedRange feedRange)"
  summary: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from the current time - so only events for all future changes will be retrieved"
  modifiers:
  - "static"
  parameters:
  - description: "The <xref uid=\"com.azure.cosmos.models.FeedRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeedRange\"></xref> that is used to define the scope (entire container,\n                  logical partition or subset of a container)"
    name: "feedRange"
    type: "<xref href=\"com.azure.cosmos.models.FeedRange?alt=com.azure.cosmos.models.FeedRange&text=FeedRange\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)"
  desc: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from the current time - so only events for all future changes will be retrieved"
  returns:
    description: "a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromPointInTime(java.time.Instant,com.azure.cosmos.models.FeedRange)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)"
  name: "createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)"
  nameWithType: "CosmosChangeFeedRequestOptions.createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)"
  summary: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from a certain point in time"
  modifiers:
  - "static"
  parameters:
  - description: "The point in time from which processing of change feed events should start"
    name: "pointInTime"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
  - description: "The <xref uid=\"com.azure.cosmos.models.FeedRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeedRange\"></xref> that is used to define the scope (entire container,\n                    logical partition or subset of a container)"
    name: "feedRange"
    type: "<xref href=\"com.azure.cosmos.models.FeedRange?alt=com.azure.cosmos.models.FeedRange&text=FeedRange\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)"
  desc: "Creates a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance to start processing change feed items from a certain point in time"
  returns:
    description: "a new <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.fullFidelity()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.fullFidelity()"
  name: "fullFidelity()"
  nameWithType: "CosmosChangeFeedRequestOptions.fullFidelity()"
  summary: "Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates."
  deprecatedTag: "use <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions.allVersionsAndDeletes()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions#allVersionsAndDeletes()\"></xref> instead."
  syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public CosmosChangeFeedRequestOptions fullFidelity()"
  desc: "Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates. Enabling AllVersionsAndDeletes change feed mode requires configuring a retention duration in the change feed policy of the container. <xref uid=\"com.azure.cosmos.models.ChangeFeedPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedPolicy\"></xref>\n\nIntermediary snapshots of changes as well as deleted documents would be available for processing for retention window before they vanish. When enabling AllVersionsAndDeletes mode you will only be able to process change feed events within the retention window configured in the change feed policy of the container. If you attempt to process a change feed after more than the retention window an error (Status Code 400) will be returned because the events for intermediary updates and deletes have vanished. It would still be possible to process changes using LatestVersion mode even when configuring a AllVersionsAndDeletes change feed policy with retention window on the container and when using LatestVersion mode it doesn't matter whether your are out of the retention window or not - but no events for deletes or intermediary updates would be included. When events are not getting processed within the retention window it is also possible to continue processing future events in AllVersionsAndDeletes mode by querying the change feed with a new CosmosChangeFeedRequestOptions instance."
  hasDeprecatedTag: true
  returns:
    description: "a <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref> instance with AllVersionsAndDeletes mode enabled"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getCustomItemSerializer()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getCustomItemSerializer()"
  name: "getCustomItemSerializer()"
  nameWithType: "CosmosChangeFeedRequestOptions.getCustomItemSerializer()"
  summary: "Gets the custom item serializer defined for this instance of request options"
  syntax: "public CosmosItemSerializer getCustomItemSerializer()"
  desc: "Gets the custom item serializer defined for this instance of request options"
  returns:
    description: "the custom item serializer"
    type: "<xref href=\"com.azure.cosmos.CosmosItemSerializer?alt=com.azure.cosmos.CosmosItemSerializer&text=CosmosItemSerializer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getDiagnosticsThresholds()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getDiagnosticsThresholds()"
  name: "getDiagnosticsThresholds()"
  nameWithType: "CosmosChangeFeedRequestOptions.getDiagnosticsThresholds()"
  summary: "Gets the diagnostic thresholds used as an override for a specific operation."
  syntax: "public CosmosDiagnosticsThresholds getDiagnosticsThresholds()"
  desc: "Gets the diagnostic thresholds used as an override for a specific operation. If no operation specific diagnostic threshold has been specified, this method will return null, although at runtime the default thresholds specified at the client-level will be used."
  returns:
    description: "the diagnostic thresholds used as an override for a specific operation."
    type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsThresholds?alt=com.azure.cosmos.CosmosDiagnosticsThresholds&text=CosmosDiagnosticsThresholds\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getExcludedRegions()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getExcludedRegions()"
  name: "getExcludedRegions()"
  nameWithType: "CosmosChangeFeedRequestOptions.getExcludedRegions()"
  summary: "Gets the list of regions to be excluded for the request/retries."
  syntax: "public List<String> getExcludedRegions()"
  desc: "Gets the list of regions to be excluded for the request/retries. These regions are excluded from the preferred region list."
  returns:
    description: "a list of excluded regions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getFeedRange()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getFeedRange()"
  name: "getFeedRange()"
  nameWithType: "CosmosChangeFeedRequestOptions.getFeedRange()"
  summary: "Gets the feed range."
  syntax: "public FeedRange getFeedRange()"
  desc: "Gets the feed range."
  returns:
    description: "the feed range."
    type: "<xref href=\"com.azure.cosmos.models.FeedRange?alt=com.azure.cosmos.models.FeedRange&text=FeedRange\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getMaxItemCount()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getMaxItemCount()"
  name: "getMaxItemCount()"
  nameWithType: "CosmosChangeFeedRequestOptions.getMaxItemCount()"
  summary: "Gets the maximum number of items to be returned in the enumeration operation."
  syntax: "public int getMaxItemCount()"
  desc: "Gets the maximum number of items to be returned in the enumeration operation."
  returns:
    description: "the max number of items."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getMaxPrefetchPageCount()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getMaxPrefetchPageCount()"
  name: "getMaxPrefetchPageCount()"
  nameWithType: "CosmosChangeFeedRequestOptions.getMaxPrefetchPageCount()"
  summary: "Gets the maximum number of pages that will be prefetched from the backend asynchronously in the background."
  syntax: "public int getMaxPrefetchPageCount()"
  desc: "Gets the maximum number of pages that will be prefetched from the backend asynchronously in the background. By pre-fetching these changes the throughput of processing the change feed records can be increased because the processing doesn't have to stop while waiting for the IO operations to retrieve a new page form the backend to complete. The only scenario where it can be useful to disable prefetching pages (with setMaxPrefetchPageCount(0)) would be when the caller only plans to retrieve just one page - so any prefetched pages would not be used anyway."
  returns:
    description: "the modified change feed request options."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getThroughputControlGroupName()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.getThroughputControlGroupName()"
  name: "getThroughputControlGroupName()"
  nameWithType: "CosmosChangeFeedRequestOptions.getThroughputControlGroupName()"
  summary: "Get the throughput control group name."
  syntax: "public String getThroughputControlGroupName()"
  desc: "Get the throughput control group name."
  returns:
    description: "The throughput control group name."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.isQuotaInfoEnabled()"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.isQuotaInfoEnabled()"
  name: "isQuotaInfoEnabled()"
  nameWithType: "CosmosChangeFeedRequestOptions.isQuotaInfoEnabled()"
  summary: "Gets the quota<wbr>Info<wbr>Enabled setting for change feed request in the Azure Cosmos DB database service."
  syntax: "public boolean isQuotaInfoEnabled()"
  desc: "Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service. quotaInfoEnabled is used to enable/disable getting quota related stats"
  returns:
    description: "true if quotaInfoEnabled is enabled"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setCustomItemSerializer(com.azure.cosmos.CosmosItemSerializer)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  name: "setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  nameWithType: "CosmosChangeFeedRequestOptions.setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  summary: "Allows specifying a custom item serializer to be used for this operation."
  parameters:
  - description: "the custom item serializer for this operation"
    name: "customItemSerializer"
    type: "<xref href=\"com.azure.cosmos.CosmosItemSerializer?alt=com.azure.cosmos.CosmosItemSerializer&text=CosmosItemSerializer\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosChangeFeedRequestOptions setCustomItemSerializer(CosmosItemSerializer customItemSerializer)"
  desc: "Allows specifying a custom item serializer to be used for this operation. If the serializer on the request options is null, the serializer on CosmosClientBuilder is used. If both serializers are null (the default), an internal Jackson ObjectMapper is ued for serialization/deserialization."
  returns:
    description: "the CosmosChangeFeedRequestOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setDiagnosticsThresholds(com.azure.cosmos.CosmosDiagnosticsThresholds)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  name: "setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  nameWithType: "CosmosChangeFeedRequestOptions.setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  summary: "Allows overriding the diagnostic thresholds for a specific operation."
  parameters:
  - description: "the diagnostic threshold override for this operation"
    name: "operationSpecificThresholds"
    type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsThresholds?alt=com.azure.cosmos.CosmosDiagnosticsThresholds&text=CosmosDiagnosticsThresholds\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)"
  desc: "Allows overriding the diagnostic thresholds for a specific operation."
  returns:
    description: "the CosmosQueryRequestOptions."
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setExcludedRegions(java.util.List<java.lang.String>)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setExcludedRegions(List<String> excludeRegions)"
  name: "setExcludedRegions(List<String> excludeRegions)"
  nameWithType: "CosmosChangeFeedRequestOptions.setExcludedRegions(List<String> excludeRegions)"
  summary: "List of regions to exclude for the request/retries."
  parameters:
  - description: "list of regions"
    name: "excludeRegions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public CosmosChangeFeedRequestOptions setExcludedRegions(List<String> excludeRegions)"
  desc: "List of regions to exclude for the request/retries. Example \"East US\" or \"East US, West US\" These regions will be excluded from the preferred regions list"
  returns:
    description: "the <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref>"
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setMaxItemCount(int)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setMaxItemCount(int maxItemCount)"
  name: "setMaxItemCount(int maxItemCount)"
  nameWithType: "CosmosChangeFeedRequestOptions.setMaxItemCount(int maxItemCount)"
  summary: "Sets the maximum number of items to be returned in the enumeration operation."
  parameters:
  - description: "the max number of items."
    name: "maxItemCount"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)"
  desc: "Sets the maximum number of items to be returned in the enumeration operation."
  returns:
    description: "the FeedOptionsBase."
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setMaxPrefetchPageCount(int)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setMaxPrefetchPageCount(int maxPrefetchPageCount)"
  name: "setMaxPrefetchPageCount(int maxPrefetchPageCount)"
  nameWithType: "CosmosChangeFeedRequestOptions.setMaxPrefetchPageCount(int maxPrefetchPageCount)"
  summary: "Sets the maximum number of pages that will be prefetched from the backend asynchronously in the background."
  parameters:
  - description: "the max number of pages that will be prefetched from the backend\n                             asynchronously in the background"
    name: "maxPrefetchPageCount"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)"
  desc: "Sets the maximum number of pages that will be prefetched from the backend asynchronously in the background. By pre-fetching these changes the throughput of processing the change feed records can be increased because the processing doesn't have to stop while waiting for the IO operations to retrieve a new page form the backend to complete. The only scenario where it can be useful to disable prefetching pages (with setMaxPrefetchPageCount(0)) would be when the caller only plans to retrieve just one page - so any prefetched pages would not be used anyway."
  returns:
    description: "the modified change feed request options."
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setQuotaInfoEnabled(boolean)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setQuotaInfoEnabled(boolean quotaInfoEnabled)"
  name: "setQuotaInfoEnabled(boolean quotaInfoEnabled)"
  nameWithType: "CosmosChangeFeedRequestOptions.setQuotaInfoEnabled(boolean quotaInfoEnabled)"
  summary: "Gets the quota<wbr>Info<wbr>Enabled setting for change feed request in the Azure Cosmos DB database service."
  parameters:
  - description: "a boolean value indicating whether quotaInfoEnabled is enabled or not"
    name: "quotaInfoEnabled"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void setQuotaInfoEnabled(boolean quotaInfoEnabled)"
  desc: "Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service. quotaInfoEnabled is used to enable/disable getting quota related stats"
- uid: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setThroughputControlGroupName(java.lang.String)"
  fullName: "com.azure.cosmos.models.CosmosChangeFeedRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
  name: "setThroughputControlGroupName(String throughputControlGroupName)"
  nameWithType: "CosmosChangeFeedRequestOptions.setThroughputControlGroupName(String throughputControlGroupName)"
  summary: "Set the throughput control group name."
  parameters:
  - description: "The throughput control group name."
    name: "throughputControlGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)"
  desc: "Set the throughput control group name."
  returns:
    description: "A <xref uid=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosChangeFeedRequestOptions\"></xref>."
    type: "<xref href=\"com.azure.cosmos.models.CosmosChangeFeedRequestOptions?alt=com.azure.cosmos.models.CosmosChangeFeedRequestOptions&text=CosmosChangeFeedRequestOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Encapsulates options that can be specified for an operation within a change feed request."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0