com.urbanairship.api.reports

Class PushListingRequest

java.lang.Object

com.urbanairship.api.reports.PushListingRequest

All Implemented Interfaces:

Request<PushListingResponse>

public class PushListingRequest
extends java.lang.Object
implements Request<PushListingResponse>

The PushListingRequest class builds push listing requests to be executed in the UrbanAirshipClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.urbanairship.api.client.Request

Request.HttpMethod

Field Summary

Fields inherited from interface com.urbanairship.api.client.Request

CONTENT_ENCODING_GZIP, CONTENT_TYPE_JSON, CONTENT_TYPE_TEXT_CSV, UA_VERSION_CSV, UA_VERSION_JSON

Method Summary

Modifier and Type	Method and Description
boolean	bearerTokenAuthRequired()
boolean	canUseBearerTokenAuth()
ContentType	getContentType()
DateTime	getEnd() Get the request end date
Request.HttpMethod	getHttpMethod()
java.util.Optional<java.lang.Integer>	getLimit() Get the page limit
java.util.Optional<java.lang.String>	getPushIdStart() Get the starting push ID
java.lang.String	getRequestBody()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
ResponseParser<PushListingResponse>	getResponseParser()
DateTime	getStart() Get the request start date
java.net.URI	getUri(java.net.URI baseUri)
static PushListingRequest	newRequest() New PushListingRequest
static PushListingRequest	newRequest(java.net.URI nextPage) Create a new push listing request listing using a next page URI.
PushListingRequest	setEnd(DateTime end) Set the request end date
PushListingRequest	setLimit(java.lang.Integer limit) Set the page limit
PushListingRequest	setPushIdStart(java.lang.String pushIdStart) Set the starting push ID
PushListingRequest	setStart(DateTime start) Set the request start date

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static PushListingRequest newRequest()

New PushListingRequest

Returns:

PushListingRequest

newRequest

public static PushListingRequest newRequest(java.net.URI nextPage)

Create a new push listing request listing using a next page URI.

Parameters:

nextPage - URI

Returns:

PushListingRequest

getStart

public DateTime getStart()

Get the request start date

Returns:

DateTime

setStart

public PushListingRequest setStart(DateTime start)

Set the request start date

Parameters:

start - DateTime

Returns:

PushListingRequest

getEnd

public DateTime getEnd()

Get the request end date

Returns:

DateTime

setEnd

public PushListingRequest setEnd(DateTime end)

Set the request end date

Parameters:

end - DateTime

Returns:

PushListingRequest

getLimit

public java.util.Optional<java.lang.Integer> getLimit()

Get the page limit

Returns:

Integer

setLimit

public PushListingRequest setLimit(java.lang.Integer limit)

Set the page limit

Parameters:

limit - Integer

Returns:

Integer

getPushIdStart

public java.util.Optional<java.lang.String> getPushIdStart()

Get the starting push ID

Returns:

String

setPushIdStart

public PushListingRequest setPushIdStart(java.lang.String pushIdStart)

Set the starting push ID

Parameters:

pushIdStart - String

Returns:

String

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<PushListingResponse>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<PushListingResponse>

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<PushListingResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<PushListingResponse>

getUri

public java.net.URI getUri(java.net.URI baseUri)
                    throws java.net.URISyntaxException

Specified by:

getUri in interface Request<PushListingResponse>

Throws:

java.net.URISyntaxException

getResponseParser

public ResponseParser<PushListingResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<PushListingResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<PushListingResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<PushListingResponse>