com.datasift.client

Class DataSiftClient

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.DataSiftClient

public class DataSiftClient
extends DataSiftApiClient

This class is the gateway to the DataSift client APIs. It provides an easy to use, configurable interface for accessing all DataSift features

Field Summary

Fields

Modifier and Type	Field and Description
String	BALANCE
String	COMPILE
protected DataSiftConfig	config
static String	DATE_FORMAT
static int	DEFAULT_NUM Where ever a numeric value is optional and it happens to be absent in a response this value will be used
String	DPU
protected DataSiftHistorics	historics
protected ConnectionManager	liveStream
static com.fasterxml.jackson.databind.ObjectMapper	MAPPER
protected DataSiftPreview	preview
protected DataSiftPush	push
protected DataSiftManagedSource	source
String	USAGE
String	VALIDATE

Constructor Summary

Constructors

Constructor and Description
DataSiftClient()
DataSiftClient(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
FutureData<Balance>	balance()
FutureData<Stream>	compile(String csdl) Compile a CSDL string to a stream hash to which you can later subscribe and receive interactions from
DataSiftConfig	config()
protected void	configureMapper()
FutureData<Dpu>	dpu(FutureData<Stream> streamFuture)
FutureData<Dpu>	dpu(Stream stream)
DataSiftHistorics	historics()
ConnectionManager	liveStream() Access to the DataSift streaming API
DataSiftManagedSource	managedSource()
DataSiftPreview	preview()
DataSiftPush	push()
void	shutdown()
FutureData<Usage>	usage()
FutureData<Usage>	usage(Usage.Period timePeriod)
FutureData<Validation>	validate(String csdl) Validate the given CSDL string against the DataSift API

Methods inherited from class com.datasift.client.DataSiftApiClient

failNotify, newParams, newRequestCallback, performRequest, unwrapFuture

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

DEFAULT_NUM

public static final int DEFAULT_NUM

Where ever a numeric value is optional and it happens to be absent in a response this value will be used

See Also:

Constant Field Values

config

protected DataSiftConfig config

historics

protected DataSiftHistorics historics

source

protected DataSiftManagedSource source

preview

protected DataSiftPreview preview

push

protected DataSiftPush push

liveStream

protected ConnectionManager liveStream

VALIDATE

public final String VALIDATE

See Also:

Constant Field Values

COMPILE

public final String COMPILE

See Also:

Constant Field Values

BALANCE

public final String BALANCE

See Also:

Constant Field Values

DPU

public final String DPU

See Also:

Constant Field Values

USAGE

public final String USAGE

See Also:

Constant Field Values

Constructor Detail

DataSiftClient

public DataSiftClient()

DataSiftClient

public DataSiftClient(DataSiftConfig config)

Parameters:

config - a configuration which should be used for making API requests

Method Detail

configureMapper

protected void configureMapper()

historics

public DataSiftHistorics historics()

Returns:

An object suitable for making requests to the DataSift Historics API

managedSource

public DataSiftManagedSource managedSource()

Returns:

An object suitable for making requests to the DataSift Managed sources API

preview

public DataSiftPreview preview()

Returns:

An object suitable for making requests to the DataSift Preview API

push

public DataSiftPush push()

Returns:

An object suitable for making requests to the DataSift Push API

config

public DataSiftConfig config()

Returns:

the instance of the configuration being used for all API calls made through this client

liveStream

public ConnectionManager liveStream()

Access to the DataSift streaming API

validate

public FutureData<Validation> validate(String csdl)

Validate the given CSDL string against the DataSift API

Parameters:

csdl - the CSDL to validate

Returns:

the results of the validation, use BaseDataSiftResult.isSuccessful() to check if validation was successful or not

compile

public FutureData<Stream> compile(String csdl)

Compile a CSDL string to a stream hash to which you can later subscribe and receive interactions from

Parameters:

csdl - the CSDL to compile

Returns:

a stream object representing the DataSift compiled CSDL, use .Stream#hash() to list the hash for the compiled CSDL

balance

public FutureData<Balance> balance()

Returns:

The balance on the account being used to make API calls

dpu

public FutureData<Dpu> dpu(Stream stream)

Parameters:

stream - the stream for which the DPU information is to be fetched

Returns:

a DPU breakdown of the stream's usage

dpu

public FutureData<Dpu> dpu(FutureData<Stream> streamFuture)

usage

public FutureData<Usage> usage()

usage

public FutureData<Usage> usage(Usage.Period timePeriod)

Parameters:

timePeriod - A time period during which the usage information should be broken down

Returns:

a break down over the time period specified

shutdown

public void shutdown()