-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.FeedRange.yml
70 lines (70 loc) · 3.62 KB
/
com.azure.cosmos.models.FeedRange.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
### YamlMime:JavaType
uid: "com.azure.cosmos.models.FeedRange"
fullName: "com.azure.cosmos.models.FeedRange"
name: "FeedRange"
nameWithType: "FeedRange"
summary: "Represents a feed range."
syntax: "public interface **FeedRange**"
methods:
- uid: "com.azure.cosmos.models.FeedRange.forFullRange()"
fullName: "com.azure.cosmos.models.FeedRange.forFullRange()"
name: "forFullRange()"
nameWithType: "FeedRange.forFullRange()"
summary: "Creates a range for an entire container"
modifiers:
- "static"
syntax: "public static FeedRange forFullRange()"
desc: "Creates a range for an entire container"
returns:
description: "A feed range for an entire container"
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.FeedRange.forLogicalPartition(com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.FeedRange.forLogicalPartition(PartitionKey partitionKey)"
name: "forLogicalPartition(PartitionKey partitionKey)"
nameWithType: "FeedRange.forLogicalPartition(PartitionKey partitionKey)"
summary: "Creates a range for a certain logical partition"
modifiers:
- "static"
parameters:
- description: "the logical partition key value"
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static FeedRange forLogicalPartition(PartitionKey partitionKey)"
desc: "Creates a range for a certain logical partition"
returns:
description: "A feed range for a certain logical partition"
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.FeedRange.fromString(java.lang.String)"
fullName: "com.azure.cosmos.models.FeedRange.fromString(String json)"
name: "fromString(String json)"
nameWithType: "FeedRange.fromString(String json)"
summary: "Creates a range from a previously obtained string representation."
modifiers:
- "static"
parameters:
- description: "A string representation of a feed range"
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static FeedRange fromString(String json)"
desc: "Creates a range from a previously obtained string representation."
returns:
description: "A 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.FeedRange.toString()"
fullName: "com.azure.cosmos.models.FeedRange.toString()"
name: "toString()"
nameWithType: "FeedRange.toString()"
summary: "Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method from<wbr>Json<wbr>String to do so)"
modifiers:
- "abstract"
overridden: "java.lang.Object.toString()"
syntax: "public abstract String toString()"
desc: "Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)"
returns:
description: "a JSON string representing the feed range"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "interface"
desc: "Represents a feed range."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0