com.datasift.client.core

Class DataSiftCore

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.core.DataSiftCore

public class DataSiftCore
extends DataSiftApiClient

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
String	BALANCE
String	COMPILE
String	DPU
String	USAGE
String	VALIDATE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftCore(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
FutureData<Dpu>	dpu(FutureData<Stream> streamFuture)
FutureData<Dpu>	dpu(Stream stream)
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

applyConfig, newParams, newRequestCallback, unwrapFuture

Methods inherited from class java.lang.Object

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

Field Detail

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

DataSiftCore

public DataSiftCore(DataSiftConfig config)

Method Detail

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 DataSiftResult.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 get 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(@NotNull
                  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(@NotNull
                  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