net.packet

Class Request

java.lang.Object

net.packet.Request

public class Request
extends java.lang.Object

Request is used to compose Packet REST API request values.

Since:

v1.0.0

Constructor Summary

Constructors

Constructor and Description
Request() Constructor
Request(Endpoint endpoint) Constructor
Request(Endpoint endpoint, java.lang.Object[] pathParams) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
Request	addPathParmas(java.lang.Object[] params)
Request	body(java.lang.Object body) Adds request body
java.net.URI	buildUri() Returns the composed endpoint URI.
java.lang.Object	getBody()
java.lang.Class<?>	getClazz()
Endpoint	getEndpoint()
HttpMethod	getMethod()
java.lang.String	getPath()
java.lang.Object[]	getPathParams()
java.util.Map<java.lang.String,java.lang.String>	getQueryParams()
Request	include(java.lang.String include) Adds packet API include options
boolean	isBodyExists() Returns to ture if body exists otherwise false
Request	page(java.lang.Integer page) Adds page no into the request
Request	perPage(java.lang.Integer perPage) Adds per page count into the request
Request	queryParam(java.lang.String key, java.lang.String value) Adds URL query parameter into the request

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request()

Constructor

Request

public Request(Endpoint endpoint)

Constructor

Parameters:

endpoint - a info about api request

Request

public Request(Endpoint endpoint,
       java.lang.Object[] pathParams)

Constructor

Parameters:

endpoint - a info about api request

pathParams - a api request path variable value(s)

Method Detail

queryParam

public Request queryParam(java.lang.String key,
                 java.lang.String value)

Adds URL query parameter into the request

Parameters:

key - a String

value - a String

Returns:

Request

page

public Request page(java.lang.Integer page)

Adds page no into the request

Parameters:

page - a integer

Returns:

Request

perPage

public Request perPage(java.lang.Integer perPage)

Adds per page count into the request

Parameters:

perPage - a integer

Returns:

Request

include

public Request include(java.lang.String include)

Adds packet API include options

For e.g.: include=emails,projects,memberships

Parameters:

include - a string

Returns:

Request

body

public Request body(java.lang.Object body)

Adds request body

Parameters:

body - an object

Returns:

Request

addPathParmas

public Request addPathParmas(java.lang.Object[] params)

isBodyExists

public boolean isBodyExists()

Returns to ture if body exists otherwise false

Returns:

boolean

buildUri

public java.net.URI buildUri()
                      throws java.net.URISyntaxException

Returns the composed endpoint URI.

Returns:

URI

Throws:

java.net.URISyntaxException - when URI is incorrect

getPath

public java.lang.String getPath()

Returns:

the path

getMethod

public HttpMethod getMethod()

Returns:

the method

getClazz

public java.lang.Class<?> getClazz()

Returns:

the clazz

getEndpoint

public Endpoint getEndpoint()

Returns:

the endpoint

getBody

public java.lang.Object getBody()

Returns:

the body

getPathParams

public java.lang.Object[] getPathParams()

Returns:

the pathParams

getQueryParams

public java.util.Map<java.lang.String,java.lang.String> getQueryParams()

Returns:

the queryParams