com.urbanairship.api.segments

Class SegmentRequest

java.lang.Object

com.urbanairship.api.segments.SegmentRequest

All Implemented Interfaces:

Request<SegmentRequestResponse>

public class SegmentRequest
extends java.lang.Object
implements Request<SegmentRequestResponse>

The SegmentRequest class builds segment 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() Get the content type.
Request.HttpMethod	getHttpMethod()
java.lang.String	getRequestBody()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
ResponseParser<SegmentRequestResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static SegmentRequest	newRequest() Create a new segment creation request.
static SegmentRequest	newUpdateRequest(java.lang.String segmentId) Create a new segment update request.
SegmentRequest	setCriteria(Selector criteria) Set the criteria for the segment request.
SegmentRequest	setDisplayName(java.lang.String displayName) Set the display name of the segment request.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static SegmentRequest newRequest()

Create a new segment creation request.

Returns:

SegmentRequest

newUpdateRequest

public static SegmentRequest newUpdateRequest(java.lang.String segmentId)

Create a new segment update request.

Parameters:

segmentId - String

Returns:

SegmentRequest

setCriteria

public SegmentRequest setCriteria(Selector criteria)

Set the criteria for the segment request.

Parameters:

criteria - Selector

Returns:

SegmentRequest

setDisplayName

public SegmentRequest setDisplayName(java.lang.String displayName)

Set the display name of the segment request.

Parameters:

displayName - String

Returns:

SegmentRequest

getContentType

public ContentType getContentType()

Get the content type.

Specified by:

getContentType in interface Request<SegmentRequestResponse>

Returns:

ContentType

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<SegmentRequestResponse>

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<SegmentRequestResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<SegmentRequestResponse>

getUri

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

Specified by:

getUri in interface Request<SegmentRequestResponse>

getResponseParser

public ResponseParser<SegmentRequestResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<SegmentRequestResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<SegmentRequestResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<SegmentRequestResponse>