com.datasift.client.pylon

Class DataSiftPylon

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.pylon.DataSiftPylon

public class DataSiftPylon
extends DataSiftApiClient

This class provides access to the DataSift Analysis API.

Field Summary

Fields

Modifier and Type	Field and Description
String	ANALYZE
String	COMPILE
String	GET
String	START
String	STOP
String	TAGS
String	VALIDATE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftPylon(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
FutureData<PylonResult>	analyze(PylonQuery query)
FutureData<PylonStream>	compile(String csdl) Compile a CSDL string to a stream hash to which you can later subscribe and receive interactions from
FutureData<PylonStreamStatusList>	get()
FutureData<PylonStreamStatusList>	get(int page)
FutureData<PylonStreamStatusList>	get(int page, int perPage)
FutureData<PylonStreamStatus>	get(String hash)
FutureData<DataSiftResult>	start(String hash) Start the stream with the given hash
FutureData<DataSiftResult>	start(String hash, String name)
FutureData<DataSiftResult>	stop(String hash)
FutureData<PylonTags>	tags(String hash)
FutureData<PylonValidation>	validate(String csdl) Validate the given CSDL string

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

VALIDATE

public final String VALIDATE

See Also:

Constant Field Values

COMPILE

public final String COMPILE

See Also:

Constant Field Values

START

public final String START

See Also:

Constant Field Values

STOP

public final String STOP

See Also:

Constant Field Values

GET

public final String GET

See Also:

Constant Field Values

ANALYZE

public final String ANALYZE

See Also:

Constant Field Values

TAGS

public final String TAGS

See Also:

Constant Field Values

Constructor Detail

DataSiftPylon

public DataSiftPylon(DataSiftConfig config)

Method Detail

validate

public FutureData<PylonValidation> validate(String csdl)

Validate the given CSDL string

Parameters:

csdl - the CSDL to validate

Returns:

the results of the validation, use Validation.isValid() to check if validation was successful

compile

public FutureData<PylonStream> 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

start

public FutureData<DataSiftResult> start(String hash)

Start the stream with the given hash

Parameters:

hash - the stream hash

Returns:

a result which can be checked for success or failure, A status 204 indicates success, or using BaseDataSiftResult.isSuccessful()

start

public FutureData<DataSiftResult> start(String hash,
                               String name)

Parameters:

hash - the stream hash

name - a name for the subscription

Returns:

a result which can be checked for success or failure, A status 204 indicates success, or using BaseDataSiftResult.isSuccessful()

stop

public FutureData<DataSiftResult> stop(String hash)

Parameters:

hash - the hash for the stream to stop

Returns:

a result which can be checked for success or failure, A status 204 indicates success, or using BaseDataSiftResult.isSuccessful()

get

public FutureData<PylonStreamStatusList> get()

get

public FutureData<PylonStreamStatusList> get(int page)

get

public FutureData<PylonStreamStatusList> get(int page,
                                    int perPage)

Returns:

the status of all streams that are running or have run with stored data

get

public FutureData<PylonStreamStatus> get(String hash)

Parameters:

hash - A stream hash

Returns:

the status of the requested stream

analyze

public FutureData<PylonResult> analyze(PylonQuery query)

Parameters:

query - pylon options for a stream

Returns:

information on execution of a stream

tags

public FutureData<PylonTags> tags(String hash)

Parameters:

hash - A filter hash

Returns:

vedo tags for the given filter