com.datasift.client

Class DataSiftResult

java.lang.Object

com.datasift.client.DataSiftResult

Direct Known Subclasses:

Balance, Dpu, HistoricsPreview, HistoricsPreviewData, HistoricsQuery, HistoricsQueryList, HistoricsStatus, ManagedSource, ManagedSourceList, ManagedSourceLog, PreparedHistoricsQuery, PulledInteractions, PushCollection, PushLogMessages, PushSubscription, PushValidation, Stream, Usage, Validation

public class DataSiftResult
extends Object

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected String	error
protected Response	response

Constructor Summary

Constructors

Constructor and Description
DataSiftResult()

Method Summary

Methods

Modifier and Type	Method and Description
void	failed(Throwable e)
Throwable	failureCause()
String	getError()
Response	getResponse()
boolean	hasFailed()
boolean	isAuthorizationSuccesful()
boolean	isSuccessful() A response is considered successful if if a response has been received, the response doesn't contain an error message AND the HTTP response status code is 200 to 399 (i.e.
int	rateLimit()
int	rateLimitCost() Not all API calls are created equally.
int	rateLimitRemaining()
void	setResponse(Response response)
void	successful()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

error

protected String error

response

protected Response response

Constructor Detail

DataSiftResult

public DataSiftResult()

Method Detail

isSuccessful

public boolean isSuccessful()

A response is considered successful if if a response has been received, the response doesn't contain an error message AND the HTTP response status code is 200 to 399 (i.e. OKs or redirects)

Returns:

true if this API result was successful.

getResponse

public Response getResponse()

setResponse

public void setResponse(Response response)

hasFailed

public boolean hasFailed()

Returns:

true if the request for this response has failed for some reason

failureCause

public Throwable failureCause()

Returns:

If the request has failed, this returns the reason for the failure May* be null

isAuthorizationSuccesful

public boolean isAuthorizationSuccesful()

Returns:

True if the response status is anything but a 401 Unauthorized

rateLimit

public int rateLimit()

Returns:

How much the rate limit is on this account DataSiftClient.DEFAULT_NUM if the information was not returned

rateLimitRemaining

public int rateLimitRemaining()

Returns:

How much is left of the rate limit quota or DataSiftClient.DEFAULT_NUM if the information was not returned

rateLimitCost

public int rateLimitCost()

Not all API calls are created equally.

Returns:

This tells you how much of your rate limit it took to generate this result or DataSiftClient.DEFAULT_NUM if the information was not returned

getError

public String getError()

Returns:

if isSuccessful() == false then this returns the error message DataSift returned or null if true

toString

public String toString()

Overrides:

toString in class Object

failed

public void failed(Throwable e)

successful

public void successful()