com.datasift.client

Interface DataSiftResult

All Known Implementing Classes:

Balance, BaseDataSiftResult, DataSiftIngestionResult, Dpu, HistoricsPreview, HistoricsPreviewData, HistoricsQuery, HistoricsQueryList, HistoricsStatus, Identity, IdentityList, Limit, LimitList, ManagedSource, ManagedSourceList, ManagedSourceLog, NewIdentity, NewLimit, NewToken, ODPBatchResponse, PreparedHistoricsQuery, PulledInteractions, PushCollection, PushLogMessages, PushSubscription, PushValidation, PylonRecording, PylonRecording.PylonRecordingId, PylonRecordingList, PylonResult, PylonSample, PylonStream, PylonTags, PylonValidation, Stream, Token, TokenList, Usage, UsageResult, Validation

public interface DataSiftResult

Author:

Courtney Robinson

Method Summary

Methods

Modifier and Type	Method and Description
void	failed(Throwable e)
Throwable	failureCause()
String	getError()
Response	getResponse()
boolean	isAuthorizationSuccessful()
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()

Method Detail

isSuccessful

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

Response getResponse()

setResponse

void setResponse(Response response)

failureCause

Throwable failureCause()

Returns:

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

isAuthorizationSuccessful

boolean isAuthorizationSuccessful()

Returns:

True if the response status is anything but a 401 Unauthorized

rateLimit

int rateLimit()

Returns:

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

rateLimitRemaining

int rateLimitRemaining()

Returns:

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

rateLimitCost

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

String getError()

Returns:

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

failed

void failed(Throwable e)

successful

void successful()