Package com.azure.core.http.rest

Class PagedResponseBase<H,T>

java.lang.Object

com.azure.core.http.rest.PagedResponseBase<H,T>

Type Parameters:

H - The HTTP response headers

T - The type of items contained in the Page

All Implemented Interfaces:

Page<T>, PagedResponse<T>, Response<List<T>>, ContinuablePage<String,T>, Closeable, AutoCloseable

public class PagedResponseBase<H,T>
extends Object
implements PagedResponse<T>

Represents an HTTP response that contains a list of items deserialized into a Page.

See Also:

PagedResponse

Constructor Summary

Constructors

Constructor	Description
PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, Page<T> page, H deserializedHeaders)	Creates a new instance of the PagedResponseBase type.
PagedResponseBase(HttpRequest request, int statusCode, HttpHeaders headers, List<T> items, String continuationToken, H deserializedHeaders)	Creates a new instance of the PagedResponseBase type.

Method Summary

Modifier and Type	Method	Description
void	close()
String	getContinuationToken()	Gets the reference to the next page.
H	getDeserializedHeaders()	Get the headers from the HTTP response, transformed into the header type H.
IterableStream<T>	getElements()	Gets an IterableStream of elements in the page.
HttpHeaders	getHeaders()	Gets the headers from the HTTP response.
HttpRequest	getRequest()	Gets the HTTP request which resulted in this response.
int	getStatusCode()	Gets the HTTP response status code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.core.http.rest.Page

getItems

Methods inherited from interface com.azure.core.http.rest.PagedResponse

getValue

Constructor Detail

PagedResponseBase

public PagedResponseBase(HttpRequest request,
                         int statusCode,
                         HttpHeaders headers,
                         Page<T> page,
                         H deserializedHeaders)

Creates a new instance of the PagedResponseBase type.

Parameters:

request - The HttpRequest that was sent to the service whose response resulted in this response.

statusCode - The status code from the response.

headers - The headers from the response.

page - The page of content returned from the service within the response.

deserializedHeaders - The headers, deserialized into an instance of type H.

PagedResponseBase

public PagedResponseBase(HttpRequest request,
                         int statusCode,
                         HttpHeaders headers,
                         List<T> items,
                         String continuationToken,
                         H deserializedHeaders)

Creates a new instance of the PagedResponseBase type.

Parameters:

request - The HttpRequest that was sent to the service whose response resulted in this response.

statusCode - The status code from the response.

headers - The headers from the response.

items - The items returned from the service within the response.

continuationToken - The continuation token returned from the service, to enable future requests to pick up from the same place in the paged iteration.

deserializedHeaders - The headers, deserialized into an instance of type H.

Method Detail

getElements

public IterableStream<T> getElements()

Gets an IterableStream of elements in the page.

Specified by:

getElements in interface ContinuablePage<H,T>

Returns:

An IterableStream containing the elements in the page.

getContinuationToken

public String getContinuationToken()

Gets the reference to the next page.

Specified by:

getContinuationToken in interface ContinuablePage<H,T>

Returns:

The next page reference or null if there isn't a next page.

getStatusCode

public int getStatusCode()

Gets the HTTP response status code.

Specified by:

getStatusCode in interface Response<H>

Returns:

The status code of the HTTP response.

getHeaders

public HttpHeaders getHeaders()

Gets the headers from the HTTP response.

Specified by:

getHeaders in interface Response<H>

Returns:

The HTTP response headers.

getRequest

public HttpRequest getRequest()

Description copied from interface: Response

Gets the HTTP request which resulted in this response.

Specified by:

getRequest in interface Response<H>

Returns:

the request which resulted in this PagedRequestResponse.

getDeserializedHeaders

public H getDeserializedHeaders()

Get the headers from the HTTP response, transformed into the header type H.

Returns:

an instance of header type H, containing the HTTP response headers.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable