-
Notifications
You must be signed in to change notification settings - Fork 255
/
com.microsoft.azure.documentdb.QueryIterable.yml
165 lines (165 loc) · 14.4 KB
/
com.microsoft.azure.documentdb.QueryIterable.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.QueryIterable"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>"
name: "QueryIterable<T>"
nameWithType: "QueryIterable<T>"
summary: "This is the template class for iterable resources in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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 class **QueryIterable<T>**</br> implements <xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.microsoft.azure.documentdb.QueryIterable.QueryIterable(com.microsoft.azure.documentdb.DocumentClient,com.microsoft.azure.documentdb.internal.ResourceType,java.lang.Class<T>,java.lang.String,com.microsoft.azure.documentdb.FeedOptionsBase)"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options)"
name: "QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options)"
nameWithType: "QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options)"
modifiers:
- "protected"
parameters:
- name: "client"
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClient?alt=com.microsoft.azure.documentdb.DocumentClient&text=DocumentClient\" data-throw-if-not-resolved=\"False\" />"
- name: "resourceType"
type: "<xref href=\"com.microsoft.azure.documentdb.internal.ResourceType?alt=com.microsoft.azure.documentdb.internal.ResourceType&text=ResourceType\" data-throw-if-not-resolved=\"False\" />"
- name: "classT"
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name: "resourceLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options)"
- uid: "com.microsoft.azure.documentdb.QueryIterable.QueryIterable(com.microsoft.azure.documentdb.DocumentClient,com.microsoft.azure.documentdb.internal.ResourceType,java.lang.Class<T>,java.lang.String,com.microsoft.azure.documentdb.FeedOptionsBase,java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options, Object partitionKey)"
name: "QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options, Object partitionKey)"
nameWithType: "QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options, Object partitionKey)"
modifiers:
- "protected"
parameters:
- name: "client"
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClient?alt=com.microsoft.azure.documentdb.DocumentClient&text=DocumentClient\" data-throw-if-not-resolved=\"False\" />"
- name: "resourceType"
type: "<xref href=\"com.microsoft.azure.documentdb.internal.ResourceType?alt=com.microsoft.azure.documentdb.internal.ResourceType&text=ResourceType\" data-throw-if-not-resolved=\"False\" />"
- name: "classT"
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name: "resourceLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
- name: "partitionKey"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options, Object partitionKey)"
- uid: "com.microsoft.azure.documentdb.QueryIterable.QueryIterable(com.microsoft.azure.documentdb.DocumentClient,com.microsoft.azure.documentdb.internal.ResourceType,java.lang.Class<T>,java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptionsBase)"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options)"
name: "QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options)"
nameWithType: "QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options)"
modifiers:
- "protected"
parameters:
- name: "client"
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClient?alt=com.microsoft.azure.documentdb.DocumentClient&text=DocumentClient\" data-throw-if-not-resolved=\"False\" />"
- name: "resourceType"
type: "<xref href=\"com.microsoft.azure.documentdb.internal.ResourceType?alt=com.microsoft.azure.documentdb.internal.ResourceType&text=ResourceType\" data-throw-if-not-resolved=\"False\" />"
- name: "classT"
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name: "resourceLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options)"
- uid: "com.microsoft.azure.documentdb.QueryIterable.QueryIterable(com.microsoft.azure.documentdb.DocumentClient,com.microsoft.azure.documentdb.internal.ResourceType,java.lang.Class<T>,java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptionsBase,java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey)"
name: "QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey)"
nameWithType: "QueryIterable<T>.QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey)"
modifiers:
- "protected"
parameters:
- name: "client"
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClient?alt=com.microsoft.azure.documentdb.DocumentClient&text=DocumentClient\" data-throw-if-not-resolved=\"False\" />"
- name: "resourceType"
type: "<xref href=\"com.microsoft.azure.documentdb.internal.ResourceType?alt=com.microsoft.azure.documentdb.internal.ResourceType&text=ResourceType\" data-throw-if-not-resolved=\"False\" />"
- name: "classT"
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name: "resourceLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptionsBase?alt=com.microsoft.azure.documentdb.FeedOptionsBase&text=FeedOptionsBase\" data-throw-if-not-resolved=\"False\" />"
- name: "partitionKey"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected QueryIterable(DocumentClient client, ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey)"
methods:
- uid: "com.microsoft.azure.documentdb.QueryIterable.fetchNextBlock()"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.fetchNextBlock()"
name: "fetchNextBlock()"
nameWithType: "QueryIterable<T>.fetchNextBlock()"
summary: "Fetch the next block of query results."
syntax: "public List<T> fetchNextBlock()"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Fetch the next block of query results."
returns:
description: "the list of fetched resources."
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.QueryIterable.getResponseHeaders()"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.getResponseHeaders()"
name: "getResponseHeaders()"
nameWithType: "QueryIterable<T>.getResponseHeaders()"
summary: "Gets the response headers."
syntax: "public Map<String,String> getResponseHeaders()"
desc: "Gets the response headers."
returns:
description: "the response headers."
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.QueryIterable.iterator()"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.iterator()"
name: "iterator()"
nameWithType: "QueryIterable<T>.iterator()"
summary: "Gets the iterator of the iterable."
syntax: "public Iterator<T> iterator()"
desc: "Gets the iterator of the iterable."
returns:
description: "the iterator."
type: "<xref href=\"java.util.Iterator?alt=java.util.Iterator&text=Iterator\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.QueryIterable.reset()"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.reset()"
name: "reset()"
nameWithType: "QueryIterable<T>.reset()"
summary: "Resets the iterable."
syntax: "public void reset()"
desc: "Resets the iterable."
- uid: "com.microsoft.azure.documentdb.QueryIterable.toList()"
fullName: "com.microsoft.azure.documentdb.QueryIterable<T>.toList()"
name: "toList()"
nameWithType: "QueryIterable<T>.toList()"
summary: "Get the list of the iterable resources."
syntax: "public List<T> toList()"
desc: "Get the list of the iterable resources."
returns:
description: "the list of the iterable resources."
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
typeParameters:
- description: "the resource type of the query iterable."
name: "T"
desc: "This is the template class for iterable resources in the Azure Cosmos DB database service."
implements:
- "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7