Class PaginatedPostRequest<T>

java.lang.Object

com.eqixiac.equinix.core.http.request.EquinixRequest<T>

com.eqixiac.equinix.core.http.request.PaginatedPostRequest<T>

Type Parameters:

T - the operation's model type

public final class PaginatedPostRequest<T>
extends EquinixRequest<T>

Request carrier for POST-based search operations whose paging state lives in the request body (a PaginatedPostBody) rather than in offset/limit query parameters. The paging pipeline advances the body's pagination between pages; because the wire entity is rebuilt from the RequestBody at every dispatch, the advanced offset is re-serialized automatically.

Author:

ianjones

Field Summary

Fields inherited from class EquinixRequest

queryParameters

Modifier and Type	Field	Description
protected Map<String, List<String>>	queryParameters

Constructor Summary

Constructors

Constructor	Description
PaginatedPostRequest()

Method Summary

Modifier and Type	Method	Description
Object	getSearchBody()	Convenience accessor for the live search body: the payload of this request's JSON RequestBody.

Methods inherited from class EquinixRequest

addHeader, addPathParameter, addQueryParameter, addQueryParameters, addSingleQueryParameter, replaceQueryParameter, setHeaders, setPathParameters, setQueryParameters

Modifier and Type	Method	Description
void	addHeader(String headerName, String headerValue)
void	addPathParameter(String parameterName, String parameterValue)
void	addQueryParameter(String parameterName, List<String> parameterValues)
void	addQueryParameters(Map<String, List<String>> parameterValues)
void	addSingleQueryParameter(String parameterName, String parameterValue)
void	replaceQueryParameter(String parameterName, List<String> parameterValues)
void	setHeaders(Map<String,String> headers)	Sets the headers, defensively copying into a mutable map (mirrors EquinixRequest.setQueryParameters(Map): addHeader mutates the stored map, so an immutable caller-supplied map must not be stored by reference).
void	setPathParameters(Map<String,String> pathParameters)	Sets the path parameters, defensively copying into a mutable map (mirrors EquinixRequest.setQueryParameters(Map): addPathParameter mutates the stored map, so an immutable caller-supplied map - e.g.
void	setQueryParameters(Map<String, List<String>> queryParameters)	Sets the query parameters, defensively deep-copying into a mutable map with mutable value lists.

Methods inherited from class Object

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

Constructor Details

PaginatedPostRequest

public PaginatedPostRequest()

Method Details

getSearchBody

public Object getSearchBody()

Convenience accessor for the live search body: the payload of this request's JSON RequestBody.

Returns:

the search body payload, or null when no JSON body is attached