Package org.azd.abstractions

Class ApiResponse

java.lang.Object

org.azd.abstractions.ApiResponse

public class ApiResponse
extends Object

Container class that holds Api request and response information.

Constructor Summary

Constructors

Constructor	Description
ApiResponse(HttpStatusCode statusCode, Map<String,List<String>> responseHeadersMap, Object responseBody, String requestUrl, RequestInformation requestInformation)

Method Summary

Modifier and Type	Method	Description
String	getContinuationToken()	Retrieves the continuation token from response header.
RequestInformation	getRequestInformation()	Get the request information object.
String	getRequestUrl()	Get the request url.
Object	getResponseBody()	Get the response body.
HttpHeaders	getResponseHeaders()	Get the response headers.
Map<String,List<String>>	getResponseHeadersMap()	Get the response headers map.
HttpStatusCode	getStatusCode()	Get the status code.

Methods inherited from class java.lang.Object

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

Constructor Details

ApiResponse

public ApiResponse(HttpStatusCode statusCode,
 Map<String,List<String>> responseHeadersMap,
 Object responseBody,
 String requestUrl,
 RequestInformation requestInformation)

Method Details

getStatusCode

public HttpStatusCode getStatusCode()

Get the status code.

Returns:

Http status code HttpStatusCode

getResponseHeaders

public HttpHeaders getResponseHeaders()

Get the response headers.

Returns:

Http headers HttpHeaders.

getResponseHeadersMap

public Map<String,List<String>> getResponseHeadersMap()

Get the response headers map.

Returns:

Map of response headers.

getResponseBody

public Object getResponseBody()

Get the response body.

Returns:

Object of response body.

getRequestUrl

public String getRequestUrl()

Get the request url.

Returns:

Request url.

getRequestInformation

public RequestInformation getRequestInformation()

Get the request information object.

Returns:

RequestInformation object RequestInformation.

getContinuationToken

public String getContinuationToken()

Retrieves the continuation token from response header. This can then be used for getting the paginated response. Note that not all the Apis return continuation token in the headers. If the header value "x-ms-continuationtoken" is present then it will be returned or an empty string will be returned.

Returns:

String value.