-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.cosmos.models.ChangeFeedPolicy.yml
111 lines (111 loc) · 11.9 KB
/
com.azure.cosmos.models.ChangeFeedPolicy.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
### YamlMime:JavaType
uid: "com.azure.cosmos.models.ChangeFeedPolicy"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy"
name: "ChangeFeedPolicy"
nameWithType: "ChangeFeedPolicy"
summary: "Represents the change feed policy configuration for the container in the Azure Cosmos DB service."
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 **ChangeFeedPolicy**"
methods:
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(java.time.Duration)"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(Duration retentionDuration)"
name: "createAllVersionsAndDeletesPolicy(Duration retentionDuration)"
nameWithType: "ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(Duration retentionDuration)"
summary: "Creates a Change<wbr>Feed<wbr>Policy with retention duration for All<wbr>Versions<wbr>And<wbr>Deletes processing"
modifiers:
- "static"
parameters:
- description: "- the retention duration (max granularity in minutes) in which it\n will be possible to process change feed events with AllVersionsAndDeletes mode."
name: "retentionDuration"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public static ChangeFeedPolicy createAllVersionsAndDeletesPolicy(Duration retentionDuration)"
desc: "Creates a ChangeFeedPolicy with retention duration for AllVersionsAndDeletes processing"
returns:
description: "ChangeFeedPolicy for AllVersionsAndDeletes change feed."
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedPolicy?alt=com.azure.cosmos.models.ChangeFeedPolicy&text=ChangeFeedPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.createFullFidelityPolicy(java.time.Duration)"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.createFullFidelityPolicy(Duration retentionDuration)"
name: "createFullFidelityPolicy(Duration retentionDuration)"
nameWithType: "ChangeFeedPolicy.createFullFidelityPolicy(Duration retentionDuration)"
summary: "Creates a Change<wbr>Feed<wbr>Policy with retention duration for All<wbr>Versions<wbr>And<wbr>Deletes processing"
deprecatedTag: "use <xref uid=\"com.azure.cosmos.models.ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(java.time.Duration)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedPolicy#createAllVersionsAndDeletesPolicy(Duration)\"></xref> instead."
modifiers:
- "static"
parameters:
- description: "- the retention duration (max granularity in minutes) in which it\n will be possible to process change feed events with AllVersionsAndDeletes mode."
name: "retentionDuration"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static ChangeFeedPolicy createFullFidelityPolicy(Duration retentionDuration)"
desc: "Creates a ChangeFeedPolicy with retention duration for AllVersionsAndDeletes processing"
hasDeprecatedTag: true
returns:
description: "ChangeFeedPolicy for AllVersionsAndDeletes change feed."
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedPolicy?alt=com.azure.cosmos.models.ChangeFeedPolicy&text=ChangeFeedPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.createIncrementalPolicy()"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.createIncrementalPolicy()"
name: "createIncrementalPolicy()"
nameWithType: "ChangeFeedPolicy.createIncrementalPolicy()"
summary: "Creates a default Change<wbr>Feed<wbr>Policy without retention duration specified."
deprecatedTag: "use <xref uid=\"com.azure.cosmos.models.ChangeFeedPolicy.createLatestVersionPolicy()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedPolicy#createLatestVersionPolicy()\"></xref> instead."
modifiers:
- "static"
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static ChangeFeedPolicy createIncrementalPolicy()"
desc: "Creates a default ChangeFeedPolicy without retention duration specified. With the default/LatestVersion change feed it will not be possible to process intermediary changes or deletes.\n\nThis is the default policy being used when not specifying any ChangeFeedPolicy for the Container."
hasDeprecatedTag: true
returns:
description: "ChangeFeedPolicy for default/LatestVersion change feed without AllVersionsAndDeletes."
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedPolicy?alt=com.azure.cosmos.models.ChangeFeedPolicy&text=ChangeFeedPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.createLatestVersionPolicy()"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.createLatestVersionPolicy()"
name: "createLatestVersionPolicy()"
nameWithType: "ChangeFeedPolicy.createLatestVersionPolicy()"
summary: "Creates a default Change<wbr>Feed<wbr>Policy without retention duration specified."
modifiers:
- "static"
syntax: "public static ChangeFeedPolicy createLatestVersionPolicy()"
desc: "Creates a default ChangeFeedPolicy without retention duration specified. With the default/LatestVersion change feed it will not be possible to process intermediary changes or deletes.\n\nThis is the default policy being used when not specifying any ChangeFeedPolicy for the Container."
returns:
description: "ChangeFeedPolicy for default/LatestVersion change feed without AllVersionsAndDeletes."
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedPolicy?alt=com.azure.cosmos.models.ChangeFeedPolicy&text=ChangeFeedPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.getFullFidelityRetentionDuration()"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.getFullFidelityRetentionDuration()"
name: "getFullFidelityRetentionDuration()"
nameWithType: "ChangeFeedPolicy.getFullFidelityRetentionDuration()"
summary: "Gets the retention duration in which it will be possible to process change feed events with All<wbr>Versions<wbr>And<wbr>Deletes mode (meaning intermediary changes and deletes will be exposed in change feed)."
deprecatedTag: "use <xref uid=\"com.azure.cosmos.models.ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedPolicy#getRetentionDurationForAllVersionsAndDeletesPolicy()\"></xref> instead"
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Duration getFullFidelityRetentionDuration()"
desc: "Gets the retention duration in which it will be possible to process change feed events with AllVersionsAndDeletes mode (meaning intermediary changes and deletes will be exposed in change feed). By default AllVersionsAndDeletes change feed is not enabled - so the retention duration would be Duration.ZERO."
hasDeprecatedTag: true
returns:
description: "AllVersionsAndDeletes retention duration."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.cosmos.models.ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy()"
fullName: "com.azure.cosmos.models.ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy()"
name: "getRetentionDurationForAllVersionsAndDeletesPolicy()"
nameWithType: "ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy()"
summary: "Gets the retention duration in which it will be possible to process change feed events with All<wbr>Versions<wbr>And<wbr>Deletes mode (meaning intermediary changes and deletes will be exposed in change feed)."
syntax: "public Duration getRetentionDurationForAllVersionsAndDeletesPolicy()"
desc: "Gets the retention duration in which it will be possible to process change feed events with AllVersionsAndDeletes mode (meaning intermediary changes and deletes will be exposed in change feed). By default AllVersionsAndDeletes change feed is not enabled - so the retention duration would be Duration.ZERO."
returns:
description: "AllVersionsAndDeletes retention duration."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
type: "class"
desc: "Represents the change feed policy configuration for the container in the Azure Cosmos DB service.\n\nThe example below creates a new container with a change feed policy for AllVersionsAndDeletes change feed with a retention window of 8 minutes - so intermediary snapshots of changes as well as deleted documents would be available for processing for 8 minutes before they vanish. Processing the change feed with AllVersionsAndDeletes mode will only be able within this retention window - if you attempt to process a change feed after more than the retention window (8 minutes in this sample) an error (Status Code 400) will be returned. 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 you are out of the retention window or not.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"ContainerName\", \"/somePartitionKeyProperty\");\n containerProperties.setChangeFeedPolicy(ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(8));\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```\n\nThe example below creates a new container with a change feed policy for LatestVersion change feed. Processing the change feed with AllVersionsAndDeletes mode will not be possible for this container. It would still be possible to process changes using LatestVersion mode. The LatestVersion change feed policy is also the default that is used when not explicitly specifying a change feed policy.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"ContainerName\", \"/somePartitionKeyProperty\");\n containerProperties.setChangeFeedPolicy(ChangeFeedPolicy.createLatestVersionPolicy());\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```"
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.61.1