azure-docs-sdk-java/docs-ref-autogen/com.azure.core.http.rest.Pa...

148 строки
11 KiB
YAML

### 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\" />&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
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\" />&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
- 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>&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
- 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\" />&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
- 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\" />&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.core.http.rest"
artifact: com.azure:azure-core:1.37.0