com.myjeeva.digitalocean.impl

Class ApiRequest

java.lang.Object

com.myjeeva.digitalocean.impl.ApiRequest

public class ApiRequest
extends java.lang.Object

Represents DigitalOcean API Request details

Since:

v2.0

Author:

Jeevanandam M. ([email protected])

Constructor Summary

Constructors

Constructor and Description
ApiRequest() Default Constructor
ApiRequest(ApiAction apiAction) Constructor
ApiRequest(ApiAction apiAction, java.lang.Integer pageNo, java.lang.Integer perPage) Constructor
ApiRequest(ApiAction apiAction, java.lang.Integer pageNo, java.util.Map<java.lang.String,java.lang.String> queryParams, java.lang.Integer perPage) Constructor
ApiRequest(ApiAction apiAction, java.lang.Object data) Constructor
ApiRequest(ApiAction apiAction, java.lang.Object[] pathParams) Constructor
ApiRequest(ApiAction apiAction, java.lang.Object[] pathParams, java.lang.Integer pageNo, java.lang.Integer perPage) Constructor
ApiRequest(ApiAction apiAction, java.lang.Object data, java.lang.Object[] pathParams) Constructor
ApiRequest(ApiAction apiAction, java.lang.Object data, java.lang.Object[] pathParams, java.lang.Integer pageNo, java.util.Map<java.lang.String,java.lang.String> queryParams, java.lang.Integer perPage) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
ApiAction	getApiAction()
java.lang.Class<?>	getClazz()
java.lang.Object	getData()
java.lang.String	getElementName()
RequestMethod	getMethod()
java.lang.Integer	getPageNo()
java.lang.String	getPath()
java.lang.Object[]	getPathParams()
java.lang.Integer	getPerPage()
java.util.Map<java.lang.String,java.lang.String>	getQueryParams()
java.lang.Boolean	isCollectionElement()
void	setApiAction(ApiAction apiAction)
void	setData(java.lang.Object data)
void	setPageNo(java.lang.Integer pageNo)
void	setPathParams(java.lang.Object[] pathParams)
void	setPerPage(java.lang.Integer perPage)
void	setQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiRequest

public ApiRequest()

Default Constructor

ApiRequest

public ApiRequest(ApiAction apiAction)

Constructor

Parameters:

apiAction - a info about api request

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Object[] pathParams)

Constructor

Parameters:

apiAction - a info about api request

pathParams - a api request path variable value(s)

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Integer pageNo,
          java.lang.Integer perPage)

Constructor

Parameters:

apiAction - a info about api request

pageNo - of the request pagination

perPage - no. of items per page

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Integer pageNo,
          java.util.Map<java.lang.String,java.lang.String> queryParams,
          java.lang.Integer perPage)

Constructor

Parameters:

apiAction - a info about api request

pageNo - of the request pagination

queryParams - of the api request

perPage - no. of items per page

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Object data)

Constructor

Parameters:

apiAction - a info about api request

data - a api request body data object

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Object[] pathParams,
          java.lang.Integer pageNo,
          java.lang.Integer perPage)

Constructor

Parameters:

apiAction - a info about api request

pathParams - a api request path variable value(s)

pageNo - of the request pagination

perPage - no. of items per page

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Object data,
          java.lang.Object[] pathParams)

Constructor

Parameters:

apiAction - a info about api request

data - a api request body data object

pathParams - a api request path variable value(s)

ApiRequest

public ApiRequest(ApiAction apiAction,
          java.lang.Object data,
          java.lang.Object[] pathParams,
          java.lang.Integer pageNo,
          java.util.Map<java.lang.String,java.lang.String> queryParams,
          java.lang.Integer perPage)

Constructor

Parameters:

apiAction - a info about api request

data - a api request body data object

pathParams - a api request path variable value(s)

pageNo - of the request pagination

queryParams - of the api request

perPage - no. of items per page

Method Detail

isCollectionElement

public java.lang.Boolean isCollectionElement()

getPath

public java.lang.String getPath()

Returns:

the path

getElementName

public java.lang.String getElementName()

Returns:

the elementName

getMethod

public RequestMethod getMethod()

Returns:

the method

getClazz

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

Returns:

the clazz

getApiAction

public ApiAction getApiAction()

Returns:

the apiAction

setApiAction

public void setApiAction(ApiAction apiAction)

Parameters:

apiAction - the apiAction to set

getData

public java.lang.Object getData()

Returns:

the data

setData

public void setData(java.lang.Object data)

Parameters:

data - the data to set

getPathParams

public java.lang.Object[] getPathParams()

Returns:

the pathParams

setPathParams

public void setPathParams(java.lang.Object[] pathParams)

Parameters:

pathParams - the pathParams to set

getQueryParams

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

Returns:

the queryParams

setQueryParams

public void setQueryParams(java.util.Map<java.lang.String,java.lang.String> queryParams)

Parameters:

queryParams - the queryParams to set

getPageNo

public java.lang.Integer getPageNo()

Returns:

the pageNo

setPageNo

public void setPageNo(java.lang.Integer pageNo)

Parameters:

pageNo - the pageNo to set

getPerPage

public java.lang.Integer getPerPage()

Returns:

the perPage

setPerPage

public void setPerPage(java.lang.Integer perPage)

Parameters:

perPage - the perPage to set