114 строки
6.7 KiB
YAML
114 строки
6.7 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.ChangeFeedOptions()
|
|
name: ChangeFeedOptions()
|
|
nameWithType: ChangeFeedOptions.ChangeFeedOptions()
|
|
syntax: public ChangeFeedOptions()
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.ChangeFeedOptions()
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.ChangeFeedOptions(ChangeFeedOptions options)
|
|
name: ChangeFeedOptions(ChangeFeedOptions options)
|
|
nameWithType: ChangeFeedOptions.ChangeFeedOptions(ChangeFeedOptions options)
|
|
parameters:
|
|
- name: options
|
|
type: <xref href="com.microsoft.azure.cosmosdb.ChangeFeedOptions?alt=com.microsoft.azure.cosmosdb.ChangeFeedOptions&text=ChangeFeedOptions" data-throw-if-not-resolved="False"/>
|
|
syntax: public ChangeFeedOptions(ChangeFeedOptions options)
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.ChangeFeedOptions(ChangeFeedOptions)
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
- <xref href="com.microsoft.azure.cosmosdb.FeedOptionsBase?alt=com.microsoft.azure.cosmosdb.FeedOptionsBase&text=FeedOptionsBase" data-throw-if-not-resolved="False"/>
|
|
inheritedMembers:
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.FeedOptionsBase()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getMaxItemCount()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getPartitionKey()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getPopulateQueryMetrics()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getProperties()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.getRequestContinuation()
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setMaxItemCount(Integer)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setPartitionKey(PartitionKey)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setPopulateQueryMetrics(boolean)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setProperties(Map<String, Object>)
|
|
- com.microsoft.azure.cosmosdb.FeedOptionsBase.setRequestContinuation(String)
|
|
methods:
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.getPartitionKeyRangeId()
|
|
name: getPartitionKeyRangeId()
|
|
nameWithType: ChangeFeedOptions.getPartitionKeyRangeId()
|
|
returns:
|
|
description: <p>a string indicating the partition key range ID </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get the partition key range id for the current request </p>
|
|
|
|
<p>ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers. </p>
|
|
|
|
<p></p>
|
|
syntax: public String getPartitionKeyRangeId()
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.getPartitionKeyRangeId()
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.getStartDateTime()
|
|
name: getStartDateTime()
|
|
nameWithType: ChangeFeedOptions.getStartDateTime()
|
|
returns:
|
|
description: <p>a zoned date time to start looking for changes after, if set or null otherwise </p>
|
|
type: <xref href="ZonedDateTime?alt=ZonedDateTime&text=ZonedDateTime" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Gets the zoned date time to start looking for changes after. </p>
|
|
syntax: public ZonedDateTime getStartDateTime()
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.getStartDateTime()
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.isStartFromBeginning()
|
|
name: isStartFromBeginning()
|
|
nameWithType: ChangeFeedOptions.isStartFromBeginning()
|
|
returns:
|
|
description: <p>a boolean value indicating change feed should start from beginning or not </p>
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).</p>
|
|
|
|
<p></p>
|
|
syntax: public boolean isStartFromBeginning()
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.isStartFromBeginning()
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setPartitionKeyRangeId(String partitionKeyRangeId)
|
|
name: setPartitionKeyRangeId(String partitionKeyRangeId)
|
|
nameWithType: ChangeFeedOptions.setPartitionKeyRangeId(String partitionKeyRangeId)
|
|
parameters:
|
|
- description: <p>a string indicating the partition key range ID </p>
|
|
name: partitionKeyRangeId
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set the partition key range id for the current request </p>
|
|
|
|
<p>ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers. </p>
|
|
|
|
<p></p>
|
|
syntax: public void setPartitionKeyRangeId(String partitionKeyRangeId)
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setPartitionKeyRangeId(String)
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setStartDateTime(ZonedDateTime startDateTime)
|
|
name: setStartDateTime(ZonedDateTime startDateTime)
|
|
nameWithType: ChangeFeedOptions.setStartDateTime(ZonedDateTime startDateTime)
|
|
parameters:
|
|
- description: <p>a zoned date time to start looking for changes after. </p>
|
|
name: startDateTime
|
|
type: <xref href="ZonedDateTime?alt=ZonedDateTime&text=ZonedDateTime" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Sets the zoned date time (exclusive) to start looking for changes after. If this is specified, startFromBeginning is ignored. </p>
|
|
syntax: public void setStartDateTime(ZonedDateTime startDateTime)
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setStartDateTime(ZonedDateTime)
|
|
- fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setStartFromBeginning(boolean startFromBeginning)
|
|
name: setStartFromBeginning(boolean startFromBeginning)
|
|
nameWithType: ChangeFeedOptions.setStartFromBeginning(boolean startFromBeginning)
|
|
parameters:
|
|
- description: <p>a boolean value indicating change feed should start from beginning or not </p>
|
|
name: startFromBeginning
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set whether change feed should start from beginning (true) or from current (false). By default it's start from current (false).</p>
|
|
|
|
<p></p>
|
|
syntax: public void setStartFromBeginning(boolean startFromBeginning)
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions.setStartFromBeginning(boolean)
|
|
nameWithType: ChangeFeedOptions
|
|
syntax: public class ChangeFeedOptions extends FeedOptionsBase
|
|
type: class
|
|
uid: com.microsoft.azure.cosmosdb.ChangeFeedOptions
|
|
fullName: com.microsoft.azure.cosmosdb.ChangeFeedOptions
|
|
name: ChangeFeedOptions
|
|
package: com.microsoft.azure.cosmosdb
|
|
summary: <p>Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB database service. </p>
|
|
metadata: {}
|