85 строки
7.3 KiB
YAML
85 строки
7.3 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.ChangeFeedOptions"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions"
|
|
name: "ChangeFeedOptions"
|
|
nameWithType: "ChangeFeedOptions"
|
|
summary: "Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB database service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase.getPageSize()?alt=com.microsoft.azure.documentdb.FeedOptionsBase.getPageSize&text=getPageSize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase.getRequestContinuation()?alt=com.microsoft.azure.documentdb.FeedOptionsBase.getRequestContinuation&text=getRequestContinuation\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase.setPageSize(java.lang.Integer)?alt=com.microsoft.azure.documentdb.FeedOptionsBase.setPageSize&text=setPageSize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase.setRequestContinuation(java.lang.String)?alt=com.microsoft.azure.documentdb.FeedOptionsBase.setRequestContinuation&text=setRequestContinuation\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final class **ChangeFeedOptions**</br> extends <xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.ChangeFeedOptions.ChangeFeedOptions()"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions.ChangeFeedOptions()"
|
|
name: "ChangeFeedOptions()"
|
|
nameWithType: "ChangeFeedOptions.ChangeFeedOptions()"
|
|
syntax: "public ChangeFeedOptions()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.ChangeFeedOptions.getPartitionKeyRangeId()"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions.getPartitionKeyRangeId()"
|
|
name: "getPartitionKeyRangeId()"
|
|
nameWithType: "ChangeFeedOptions.getPartitionKeyRangeId()"
|
|
summary: "Get the partition key range id for the current request"
|
|
syntax: "public String getPartitionKeyRangeId()"
|
|
desc: "Get the partition key range id for the current request\n\nChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers."
|
|
returns:
|
|
description: "a string indicating the partition key range ID"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.ChangeFeedOptions.isStartFromBeginning()"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions.isStartFromBeginning()"
|
|
name: "isStartFromBeginning()"
|
|
nameWithType: "ChangeFeedOptions.isStartFromBeginning()"
|
|
summary: "Get whether change feed should start from beginning (true) or from current (false)."
|
|
syntax: "public boolean isStartFromBeginning()"
|
|
desc: "Get whether change feed should start from beginning (true) or from current (false). By default it's start from current (false)."
|
|
returns:
|
|
description: "a boolean value indicating change feed should start from beginning or not"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.ChangeFeedOptions.setPartitionKeyRangeId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions.setPartitionKeyRangeId(String partitionKeyRangeId)"
|
|
name: "setPartitionKeyRangeId(String partitionKeyRangeId)"
|
|
nameWithType: "ChangeFeedOptions.setPartitionKeyRangeId(String partitionKeyRangeId)"
|
|
summary: "Set the partition key range id for the current request"
|
|
parameters:
|
|
- description: "a string indicating the partition key range ID"
|
|
name: "partitionKeyRangeId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setPartitionKeyRangeId(String partitionKeyRangeId)"
|
|
desc: "Set the partition key range id for the current request\n\nChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers."
|
|
- uid: "com.microsoft.azure.documentdb.ChangeFeedOptions.setStartFromBeginning(boolean)"
|
|
fullName: "com.microsoft.azure.documentdb.ChangeFeedOptions.setStartFromBeginning(boolean startFromBeginning)"
|
|
name: "setStartFromBeginning(boolean startFromBeginning)"
|
|
nameWithType: "ChangeFeedOptions.setStartFromBeginning(boolean startFromBeginning)"
|
|
summary: "Set whether change feed should start from beginning (true) or from current (false)."
|
|
parameters:
|
|
- description: "a boolean value indicating change feed should start from beginning or not"
|
|
name: "startFromBeginning"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setStartFromBeginning(boolean startFromBeginning)"
|
|
desc: "Set whether change feed should start from beginning (true) or from current (false). By default it's start from current (false)."
|
|
type: "class"
|
|
desc: "Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|