-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.core.http.rest.PagedResponseBase.yml
147 lines (147 loc) · 11.1 KB
/
com.azure.core.http.rest.PagedResponseBase.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
### YamlMime:JavaType
uid: "com.azure.core.http.rest.PagedResponseBase"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>"
name: "PagedResponseBase<H,T>"
nameWithType: "PagedResponseBase<H,T>"
summary: "Represents an HTTP response that contains a list of items deserialized into a <xref uid=\"com.azure.core.http.rest.Page\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Page\"></xref>."
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 class **PagedResponseBase<H,T>**</br> implements <xref href=\"com.azure.core.http.rest.PagedResponse?alt=com.azure.core.http.rest.PagedResponse&text=PagedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.core.http.rest.PagedResponseBase.PagedResponseBase(com.azure.core.http.HttpRequest,int,com.azure.core.http.HttpHeaders,com.azure.core.http.rest.Page<T>,H)"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, Page<T> page, H deserializedHeaders)"
name: "PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, Page<T> page, H deserializedHeaders)"
nameWithType: "PagedResponseBase<H,T>.PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, Page<T> page, H deserializedHeaders)"
summary: "Creates a new instance of the Paged<wbr>Response<wbr>Base type."
parameters:
- description: "The HttpRequest that was sent to the service whose response resulted in this response."
name: "request"
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- description: "The status code from the response."
name: "statusCode"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "The headers from the response."
name: "headers"
type: "<xref href=\"com.azure.core.http.HttpHeaders?alt=com.azure.core.http.HttpHeaders&text=HttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- description: "The page of content returned from the service within the response."
name: "page"
type: "<xref href=\"com.azure.core.http.rest.Page?alt=com.azure.core.http.rest.Page&text=Page\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- description: "The headers, deserialized into an instance of type H."
name: "deserializedHeaders"
type: "<xref href=\"H?alt=H&text=H\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, Page<T> page, H deserializedHeaders)"
desc: "Creates a new instance of the PagedResponseBase type."
- uid: "com.azure.core.http.rest.PagedResponseBase.PagedResponseBase(com.azure.core.http.HttpRequest,int,com.azure.core.http.HttpHeaders,java.util.List<T>,java.lang.String,H)"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, List<T> items, String continuationToken, H deserializedHeaders)"
name: "PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, List<T> items, String continuationToken, H deserializedHeaders)"
nameWithType: "PagedResponseBase<H,T>.PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, List<T> items, String continuationToken, H deserializedHeaders)"
summary: "Creates a new instance of the Paged<wbr>Response<wbr>Base type."
parameters:
- description: "The HttpRequest that was sent to the service whose response resulted in this response."
name: "request"
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- description: "The status code from the response."
name: "statusCode"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "The headers from the response."
name: "headers"
type: "<xref href=\"com.azure.core.http.HttpHeaders?alt=com.azure.core.http.HttpHeaders&text=HttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- description: "The items returned from the service within the response."
name: "items"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- description: "The continuation token returned from the service, to enable future requests to pick up\n from the same place in the paged iteration."
name: "continuationToken"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The headers, deserialized into an instance of type H."
name: "deserializedHeaders"
type: "<xref href=\"H?alt=H&text=H\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, List<T> items, String continuationToken, H deserializedHeaders)"
desc: "Creates a new instance of the PagedResponseBase type."
methods:
- uid: "com.azure.core.http.rest.PagedResponseBase.close()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.close()"
name: "close()"
nameWithType: "PagedResponseBase<H,T>.close()"
syntax: "public void close()"
- uid: "com.azure.core.http.rest.PagedResponseBase.getContinuationToken()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getContinuationToken()"
name: "getContinuationToken()"
nameWithType: "PagedResponseBase<H,T>.getContinuationToken()"
summary: "Gets the reference to the next page."
syntax: "public String getContinuationToken()"
desc: "Gets the reference to the next page."
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.core.http.rest.PagedResponseBase.getDeserializedHeaders()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getDeserializedHeaders()"
name: "getDeserializedHeaders()"
nameWithType: "PagedResponseBase<H,T>.getDeserializedHeaders()"
summary: "Get the headers from the HTTP response, transformed into the header type H."
syntax: "public H getDeserializedHeaders()"
desc: "Get the headers from the HTTP response, transformed into the header type H."
returns:
description: "an instance of header type H, containing the HTTP response headers."
type: "<xref href=\"H?alt=H&text=H\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.rest.PagedResponseBase.getElements()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getElements()"
name: "getElements()"
nameWithType: "PagedResponseBase<H,T>.getElements()"
summary: "Gets an <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of elements in the page."
syntax: "public IterableStream<T> getElements()"
desc: "Gets an <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of elements in the page."
returns:
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.core.http.rest.PagedResponseBase.getHeaders()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getHeaders()"
name: "getHeaders()"
nameWithType: "PagedResponseBase<H,T>.getHeaders()"
summary: "Gets the headers from the HTTP response."
syntax: "public HttpHeaders getHeaders()"
desc: "Gets the headers from the HTTP response."
returns:
type: "<xref href=\"com.azure.core.http.HttpHeaders?alt=com.azure.core.http.HttpHeaders&text=HttpHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.rest.PagedResponseBase.getRequest()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getRequest()"
name: "getRequest()"
nameWithType: "PagedResponseBase<H,T>.getRequest()"
summary: "Gets the HTTP request which resulted in this response."
syntax: "public HttpRequest getRequest()"
desc: "Gets the HTTP request which resulted in this response."
returns:
description: "the request which resulted in this PagedRequestResponse."
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.rest.PagedResponseBase.getStatusCode()"
fullName: "com.azure.core.http.rest.PagedResponseBase<H,T>.getStatusCode()"
name: "getStatusCode()"
nameWithType: "PagedResponseBase<H,T>.getStatusCode()"
summary: "Gets the HTTP response status code."
syntax: "public int getStatusCode()"
desc: "Gets the HTTP response status code."
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
type: "class"
typeParameters:
- description: "The HTTP response headers"
name: "H"
- description: "The type of items contained in the <xref uid=\"Page\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Page\"></xref>"
name: "T"
desc: "Represents an HTTP response that contains a list of items deserialized into a <xref uid=\"com.azure.core.http.rest.Page\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Page\"></xref>."
implements:
- "<xref href=\"com.azure.core.http.rest.PagedResponse?alt=com.azure.core.http.rest.PagedResponse&text=PagedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.core.http.rest"
artifact: com.azure:azure-core:1.49.1