399 строки
35 KiB
YAML
399 строки
35 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions"
|
|
name: "ChangeFeedProcessorOptions"
|
|
nameWithType: "ChangeFeedProcessorOptions"
|
|
summary: "Specifies the options associated with <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref>."
|
|
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 **ChangeFeedProcessorOptions**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.ChangeFeedProcessorOptions()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.ChangeFeedProcessorOptions()"
|
|
name: "ChangeFeedProcessorOptions()"
|
|
nameWithType: "ChangeFeedProcessorOptions.ChangeFeedProcessorOptions()"
|
|
summary: "Instantiates a new Change feed processor options."
|
|
syntax: "public ChangeFeedProcessorOptions()"
|
|
desc: "Instantiates a new Change feed processor options."
|
|
fields:
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_ACQUIRE_INTERVAL"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_ACQUIRE_INTERVAL"
|
|
name: "DEFAULT_ACQUIRE_INTERVAL"
|
|
nameWithType: "ChangeFeedProcessorOptions.DEFAULT_ACQUIRE_INTERVAL"
|
|
summary: "Default acquire interval."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public static final Duration DEFAULT_ACQUIRE_INTERVAL"
|
|
desc: "Default acquire interval."
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_EXPIRATION_INTERVAL"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_EXPIRATION_INTERVAL"
|
|
name: "DEFAULT_EXPIRATION_INTERVAL"
|
|
nameWithType: "ChangeFeedProcessorOptions.DEFAULT_EXPIRATION_INTERVAL"
|
|
summary: "Default expiration interval."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public static final Duration DEFAULT_EXPIRATION_INTERVAL"
|
|
desc: "Default expiration interval."
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_FEED_POLL_DELAY"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_FEED_POLL_DELAY"
|
|
name: "DEFAULT_FEED_POLL_DELAY"
|
|
nameWithType: "ChangeFeedProcessorOptions.DEFAULT_FEED_POLL_DELAY"
|
|
summary: "Default feed poll delay."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public static final Duration DEFAULT_FEED_POLL_DELAY"
|
|
desc: "Default feed poll delay."
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_RENEW_INTERVAL"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.DEFAULT_RENEW_INTERVAL"
|
|
name: "DEFAULT_RENEW_INTERVAL"
|
|
nameWithType: "ChangeFeedProcessorOptions.DEFAULT_RENEW_INTERVAL"
|
|
summary: "Default renew interval."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public static final Duration DEFAULT_RENEW_INTERVAL"
|
|
desc: "Default renew interval."
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getFeedPollDelay()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getFeedPollDelay()"
|
|
name: "getFeedPollDelay()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getFeedPollDelay()"
|
|
summary: "Gets the delay in between polling a partition for new changes on the feed, after all current changes are drained."
|
|
syntax: "public Duration getFeedPollDelay()"
|
|
desc: "Gets the delay in between polling a partition for new changes on the feed, after all current changes are drained."
|
|
returns:
|
|
description: "the delay in between polling a partition for new changes on the feed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getFeedPollThroughputControlGroupConfig()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getFeedPollThroughputControlGroupConfig()"
|
|
name: "getFeedPollThroughputControlGroupConfig()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getFeedPollThroughputControlGroupConfig()"
|
|
summary: "Get the feed pool throughput control config."
|
|
syntax: "public ThroughputControlGroupConfig getFeedPollThroughputControlGroupConfig()"
|
|
desc: "Get the feed pool throughput control config."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfig\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfig?alt=com.azure.cosmos.ThroughputControlGroupConfig&text=ThroughputControlGroupConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseAcquireInterval()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseAcquireInterval()"
|
|
name: "getLeaseAcquireInterval()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getLeaseAcquireInterval()"
|
|
summary: "Gets the interval to kick off a task to compute if partitions are distributed evenly among known host instances."
|
|
syntax: "public Duration getLeaseAcquireInterval()"
|
|
desc: "Gets the interval to kick off a task to compute if partitions are distributed evenly among known host instances."
|
|
returns:
|
|
description: "the interval to kick off a task to compute if partitions are distributed evenly among known host\n instances."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseExpirationInterval()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseExpirationInterval()"
|
|
name: "getLeaseExpirationInterval()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getLeaseExpirationInterval()"
|
|
summary: "Gets the interval for which the lease is taken on a lease representing a partition."
|
|
syntax: "public Duration getLeaseExpirationInterval()"
|
|
desc: "Gets the interval for which the lease is taken on a lease representing a partition.\n\nIf the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
returns:
|
|
description: "the interval for which the lease is taken on a lease representing a partition."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeasePrefix()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeasePrefix()"
|
|
name: "getLeasePrefix()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getLeasePrefix()"
|
|
summary: "Gets a prefix to be used as part of the lease ID."
|
|
syntax: "public String getLeasePrefix()"
|
|
desc: "Gets a prefix to be used as part of the lease ID.\n\nThis can be used to support multiple instances of <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instances pointing at the same feed while using the same auxiliary container."
|
|
returns:
|
|
description: "a prefix to be used as part of the lease ID."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseRenewInterval()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getLeaseRenewInterval()"
|
|
name: "getLeaseRenewInterval()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getLeaseRenewInterval()"
|
|
summary: "Gets the renew interval for all leases for partitions currently held by <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
syntax: "public Duration getLeaseRenewInterval()"
|
|
desc: "Gets the renew interval for all leases for partitions currently held by <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
returns:
|
|
description: "the renew interval for all leases for partitions."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMaxItemCount()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMaxItemCount()"
|
|
name: "getMaxItemCount()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getMaxItemCount()"
|
|
summary: "Gets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service."
|
|
syntax: "public int getMaxItemCount()"
|
|
desc: "Gets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMaxScaleCount()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMaxScaleCount()"
|
|
name: "getMaxScaleCount()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getMaxScaleCount()"
|
|
summary: "Gets the maximum number of partitions (parallel workers) the host can run."
|
|
syntax: "public int getMaxScaleCount()"
|
|
desc: "Gets the maximum number of partitions (parallel workers) the host can run.\n\nThis option can be used to limit the number of partitions (parallel workers) for the host and thus override the default equal distribution of leases between multiple hosts. Default setting is \"0\", unlimited."
|
|
returns:
|
|
description: "the maximum number of partitions (parallel workers) the host can run."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMinScaleCount()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getMinScaleCount()"
|
|
name: "getMinScaleCount()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getMinScaleCount()"
|
|
summary: "Gets the minimum partition count (parallel workers) for the current host."
|
|
syntax: "public int getMinScaleCount()"
|
|
desc: "Gets the minimum partition count (parallel workers) for the current host.\n\nThis option can be used to increase the number of partitions (parallel workers) for the host and thus override the default equal distribution of leases between multiple hosts."
|
|
returns:
|
|
description: "the minimum scale count for the host."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getScheduler()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getScheduler()"
|
|
name: "getScheduler()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getScheduler()"
|
|
summary: "Gets the internal <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of Executor<wbr>Service-based workers for any change feed processor related tasks."
|
|
syntax: "public Scheduler getScheduler()"
|
|
desc: "Gets the internal <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of ExecutorService-based workers for any change feed processor related tasks."
|
|
returns:
|
|
description: "a <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of ExecutorService-based workers.."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/scheduler/Scheduler.html\">Scheduler</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getStartContinuation()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getStartContinuation()"
|
|
name: "getStartContinuation()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getStartContinuation()"
|
|
summary: "Gets the start request continuation token to start looking for changes after."
|
|
syntax: "public String getStartContinuation()"
|
|
desc: "Gets the start request continuation token to start looking for changes after.\n\nThis option can be used when lease store is not initialized and it is ignored if a lease item exists and has continuation token that is not null. If this is specified, both StartTime and StartFromBeginning are ignored."
|
|
returns:
|
|
description: "the string representing a continuation token that will be used to get item feeds starting with."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getStartTime()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "ChangeFeedProcessorOptions.getStartTime()"
|
|
summary: "Gets the time (exclusive) to start looking for changes after."
|
|
syntax: "public Instant getStartTime()"
|
|
desc: "Gets the time (exclusive) to start looking for changes after.\n\nThis option can be used when: (1) Lease items are not initialized; this setting will be ignored if the lease items exists and have a valid continuation token. (2) Start continuation token option is not specified. If this option is specified, \"start from beginning\" option is ignored."
|
|
returns:
|
|
description: "the time (exclusive) to start looking for changes after."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.isStartFromBeginning()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.isStartFromBeginning()"
|
|
name: "isStartFromBeginning()"
|
|
nameWithType: "ChangeFeedProcessorOptions.isStartFromBeginning()"
|
|
summary: "Gets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false)."
|
|
syntax: "public boolean isStartFromBeginning()"
|
|
desc: "Gets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false). By default it's start from current (false).\n\nThis option can be used when: (1) Lease items are not initialized; this setting will be ignored if the lease items exists and have a valid continuation token. (2) Start continuation token option is not specified. (3) Start time option is not specified."
|
|
returns:
|
|
description: "a value indicating whether change feed in the Azure Cosmos DB service should start from."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setFeedPollDelay(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setFeedPollDelay(Duration feedPollDelay)"
|
|
name: "setFeedPollDelay(Duration feedPollDelay)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setFeedPollDelay(Duration feedPollDelay)"
|
|
summary: "Sets the delay in between polling a partition for new changes on the feed, after all current changes are drained."
|
|
parameters:
|
|
- description: "the delay in between polling a partition for new changes on the feed, after all current\n changes are drained."
|
|
name: "feedPollDelay"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setFeedPollDelay(Duration feedPollDelay)"
|
|
desc: "Sets the delay in between polling a partition for new changes on the feed, after all current changes are drained."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setFeedPollThroughputControlConfig(com.azure.cosmos.ThroughputControlGroupConfig)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setFeedPollThroughputControlConfig(ThroughputControlGroupConfig feedPollThroughputControlGroupConfig)"
|
|
name: "setFeedPollThroughputControlConfig(ThroughputControlGroupConfig feedPollThroughputControlGroupConfig)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setFeedPollThroughputControlConfig(ThroughputControlGroupConfig feedPollThroughputControlGroupConfig)"
|
|
summary: "Set the feed poll local throughput control config."
|
|
parameters:
|
|
- description: "the throughput control for change feed requests for the monitored collection"
|
|
name: "feedPollThroughputControlGroupConfig"
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfig?alt=com.azure.cosmos.ThroughputControlGroupConfig&text=ThroughputControlGroupConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorOptions setFeedPollThroughputControlConfig(ThroughputControlGroupConfig feedPollThroughputControlGroupConfig)"
|
|
desc: "Set the feed poll local throughput control config. Please use this config with caution. By default, CFP will try to process the changes as fast as possible, only use this config if you want to limit the RU that can be used for your change feed processing. By using this config, it can slow down the process and cause the lag. For direct mode, please configure the throughput control group with the total RU you would allow for changeFeed processing. For gateway mode, please configure the throughput control group with the total RU you would allow for changeFeed processing / total CFP Instances."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.cosmos.models.ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessorOptions\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseAcquireInterval(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseAcquireInterval(Duration leaseAcquireInterval)"
|
|
name: "setLeaseAcquireInterval(Duration leaseAcquireInterval)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setLeaseAcquireInterval(Duration leaseAcquireInterval)"
|
|
summary: "Sets he interval to kick off a task to compute if partitions are distributed evenly among known host instances."
|
|
parameters:
|
|
- description: "he interval to kick off a task to compute if partitions are distributed evenly\n among known host instances."
|
|
name: "leaseAcquireInterval"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setLeaseAcquireInterval(Duration leaseAcquireInterval)"
|
|
desc: "Sets he interval to kick off a task to compute if partitions are distributed evenly among known host instances."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseExpirationInterval(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseExpirationInterval(Duration leaseExpirationInterval)"
|
|
name: "setLeaseExpirationInterval(Duration leaseExpirationInterval)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setLeaseExpirationInterval(Duration leaseExpirationInterval)"
|
|
summary: "Sets the interval for which the lease is taken on a lease representing a partition."
|
|
parameters:
|
|
- description: "the interval for which the lease is taken on a lease representing a partition."
|
|
name: "leaseExpirationInterval"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setLeaseExpirationInterval(Duration leaseExpirationInterval)"
|
|
desc: "Sets the interval for which the lease is taken on a lease representing a partition.\n\nIf the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeasePrefix(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeasePrefix(String leasePrefix)"
|
|
name: "setLeasePrefix(String leasePrefix)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setLeasePrefix(String leasePrefix)"
|
|
summary: "Sets a prefix to be used as part of the lease ID."
|
|
parameters:
|
|
- description: "a prefix to be used as part of the lease ID."
|
|
name: "leasePrefix"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setLeasePrefix(String leasePrefix)"
|
|
desc: "Sets a prefix to be used as part of the lease ID."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseRenewInterval(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setLeaseRenewInterval(Duration leaseRenewInterval)"
|
|
name: "setLeaseRenewInterval(Duration leaseRenewInterval)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setLeaseRenewInterval(Duration leaseRenewInterval)"
|
|
summary: "Sets the renew interval for all leases for partitions currently held by <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
parameters:
|
|
- description: "the renew interval for all leases for partitions currently held by\n <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
name: "leaseRenewInterval"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setLeaseRenewInterval(Duration leaseRenewInterval)"
|
|
desc: "Sets the renew interval for all leases for partitions currently held by <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMaxItemCount(int)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMaxItemCount(int maxItemCount)"
|
|
name: "setMaxItemCount(int maxItemCount)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setMaxItemCount(int maxItemCount)"
|
|
summary: "Sets the maximum number of items to be returned in the enumeration operation."
|
|
parameters:
|
|
- description: "the maximum number of items to be returned in the enumeration operation."
|
|
name: "maxItemCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorOptions setMaxItemCount(int maxItemCount)"
|
|
desc: "Sets the maximum number of items to be returned in the enumeration operation.\n\nNOTE: There are some cases where the number of items returned from the Change Feed can be higher than the specified value. If items in the container are being written through stored procedures, transactional batch, or bulk, they share the same [transaction][] and the same bookkeeping, so they will be returned together when read through the Change Feed.\n\n\n[transaction]: https://docs.microsoft.com/azure/cosmos-db/sql/stored-procedures-triggers-udfs#transactions"
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMaxScaleCount(int)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMaxScaleCount(int maxScaleCount)"
|
|
name: "setMaxScaleCount(int maxScaleCount)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setMaxScaleCount(int maxScaleCount)"
|
|
summary: "Sets the maximum number of partitions (parallel workers) the host can run."
|
|
parameters:
|
|
- description: "the maximum number of partitions (parallel workers) the host can run."
|
|
name: "maxScaleCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorOptions setMaxScaleCount(int maxScaleCount)"
|
|
desc: "Sets the maximum number of partitions (parallel workers) the host can run.\n\nThis option can be used to limit the number of partitions (parallel workers) for the host and thus override the default equal distribution of leases between multiple hosts. Default setting is \"0\", unlimited."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMinScaleCount(int)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setMinScaleCount(int minScaleCount)"
|
|
name: "setMinScaleCount(int minScaleCount)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setMinScaleCount(int minScaleCount)"
|
|
summary: "Sets the minimum partition count (parallel workers) for the current host."
|
|
parameters:
|
|
- description: "the minimum partition count for the host."
|
|
name: "minScaleCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorOptions setMinScaleCount(int minScaleCount)"
|
|
desc: "Sets the minimum partition count (parallel workers) for the current host.\n\nThis option can be used to increase the number of partitions (parallel workers) for the host and thus override the default equal distribution of leases between multiple hosts."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setScheduler(reactor.core.scheduler.Scheduler)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setScheduler(Scheduler scheduler)"
|
|
name: "setScheduler(Scheduler scheduler)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setScheduler(Scheduler scheduler)"
|
|
summary: "Sets the internal <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of Executor<wbr>Service-based workers for any change feed processor related tasks."
|
|
parameters:
|
|
- description: "a <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of ExecutorService-based workers.\n <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance."
|
|
name: "scheduler"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/scheduler/Scheduler.html\">Scheduler</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setScheduler(Scheduler scheduler)"
|
|
desc: "Sets the internal <xref uid=\"reactor.core.scheduler.Scheduler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Scheduler\"></xref> that hosts a pool of ExecutorService-based workers for any change feed processor related tasks."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartContinuation(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartContinuation(String startContinuation)"
|
|
name: "setStartContinuation(String startContinuation)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setStartContinuation(String startContinuation)"
|
|
summary: "Sets the start request continuation token to start looking for changes after."
|
|
parameters:
|
|
- description: "the start request continuation token to start looking for changes after."
|
|
name: "startContinuation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setStartContinuation(String startContinuation)"
|
|
desc: "Sets the start request continuation token to start looking for changes after.\n\nThis option can be used when lease store is not initialized and it is ignored if a lease item exists and has continuation token that is not null. If this is specified, both StartTime and StartFromBeginning are ignored."
|
|
returns:
|
|
description: "the string representing a continuation token that will be used to get item feeds starting with."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartFromBeginning(boolean)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartFromBeginning(boolean startFromBeginning)"
|
|
name: "setStartFromBeginning(boolean startFromBeginning)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setStartFromBeginning(boolean startFromBeginning)"
|
|
summary: "Sets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning."
|
|
parameters:
|
|
- description: "Indicates to start from beginning if true"
|
|
name: "startFromBeginning"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorOptions setStartFromBeginning(boolean startFromBeginning)"
|
|
desc: "Sets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning.\n\nThis option can be used when: (1) Lease items are not initialized; this setting will be ignored if the lease items exists and have a valid continuation token. (2) Start continuation token option is not specified. (3) Start time option is not specified."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartTime(java.time.Instant)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorOptions.setStartTime(Instant startTime)"
|
|
name: "setStartTime(Instant startTime)"
|
|
nameWithType: "ChangeFeedProcessorOptions.setStartTime(Instant startTime)"
|
|
summary: "Sets the time (exclusive) to start looking for changes after (UTC time)."
|
|
parameters:
|
|
- description: "the time (exclusive) to start looking for changes after."
|
|
name: "startTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
|
|
syntax: "public ChangeFeedProcessorOptions setStartTime(Instant startTime)"
|
|
desc: "Sets the time (exclusive) to start looking for changes after (UTC time).\n\nThis option can be used when: (1) Lease items are not initialized; this setting will be ignored if the lease items exists and have a valid continuation token. (2) Start continuation token option is not specified. If this option is specified, \"start from beginning\" option is ignored."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorOptions instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorOptions?alt=com.azure.cosmos.models.ChangeFeedProcessorOptions&text=ChangeFeedProcessorOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Specifies the options associated with <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|