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	SAMPLE
String	START
String	STOP
String	TAGS
String	UPDATE
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) Analyze a given recording and retrieve results.
FutureData<PylonStream>	compile(String csdl) Compile a CSDL string to a stream hash to which you can later subscribe and receive interactions from.
FutureData<PylonRecordingList>	get() Get the status of all recordings.
FutureData<PylonRecordingList>	get(int page) Get the status of all recordings on page given.
FutureData<PylonRecordingList>	get(int page, int perPage) Get the status of all recordings on page given.
FutureData<PylonRecording>	get(PylonRecording.PylonRecordingId recordingId) Get the status of the recording with a given id.
FutureData<DataSiftResult>	restart(PylonRecording.PylonRecordingId recordingId) Restart a recording using a recording id.
FutureData<PylonSample>	sample(PylonSampleRequest sampleRequest) Sample a Pylon recording.
FutureData<PylonRecording.PylonRecordingId>	start(PylonStream stream) Start the stream with the given hash.
FutureData<PylonRecording.PylonRecordingId>	start(PylonStream stream, String name) Start a recording with the given hash & name.
FutureData<DataSiftResult>	stop(PylonRecording.PylonRecordingId recordingId) Stop the stream with the given hash.
FutureData<PylonTags>	tags(PylonRecording.PylonRecordingId recordingId) Retrieve VEDO tags for a given recording.
FutureData<DataSiftResult>	update(PylonRecording.PylonRecordingId recordingId, PylonStream stream)
FutureData<DataSiftResult>	update(PylonRecording.PylonRecordingId recordingId, PylonStream stream, String newName)
FutureData<DataSiftResult>	update(PylonRecording.PylonRecordingId recordingId, String newName)
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

UPDATE

public final String UPDATE

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

SAMPLE

public final String SAMPLE

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. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonvalidate

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. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pyloncompile

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<PylonRecording.PylonRecordingId> start(PylonStream stream)

Start the stream with the given hash. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonstart

Parameters:

stream - the stream hash

Returns:

a Datasift pylon recording id. See PylonRecording.PylonRecordingId

start

public FutureData<PylonRecording.PylonRecordingId> start(PylonStream stream,
                                                String name)

Start a recording with the given hash & name. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonstart

Parameters:

stream - the stream hash

name - a name for the subscription

Returns:

a Datasift pylon recording id. See PylonRecording.PylonRecordingId

restart

public FutureData<DataSiftResult> restart(PylonRecording.PylonRecordingId recordingId)

Restart a recording using a recording id. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonstart

Parameters:

recordingId - the recording id of a previously stopped recording. See PylonRecording.PylonRecordingId

Returns:

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

update

public FutureData<DataSiftResult> update(PylonRecording.PylonRecordingId recordingId,
                                String newName)

update

public FutureData<DataSiftResult> update(PylonRecording.PylonRecordingId recordingId,
                                PylonStream stream)

update

public FutureData<DataSiftResult> update(PylonRecording.PylonRecordingId recordingId,
                                PylonStream stream,
                                String newName)

stop

public FutureData<DataSiftResult> stop(PylonRecording.PylonRecordingId recordingId)

Stop the stream with the given hash. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonstop

Parameters:

recordingId - the id for the recording to stop. See PylonRecording.PylonRecordingId

Returns:

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

get

public FutureData<PylonRecordingList> get()

Get the status of all recordings. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonget

Returns:

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

get

public FutureData<PylonRecordingList> get(int page)

Get the status of all recordings on page given. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonget

Returns:

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

get

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

Get the status of all recordings on page given. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonget

Returns:

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

get

public FutureData<PylonRecording> get(PylonRecording.PylonRecordingId recordingId)

Get the status of the recording with a given id. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonget

Parameters:

recordingId - id for the required recording. See PylonRecording.PylonRecordingId

Returns:

the status of the requested recording

analyze

public FutureData<PylonResult> analyze(PylonQuery query)

Analyze a given recording and retrieve results. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonanalyze

Parameters:

query - pylon options for a recording

Returns:

information on execution of a recording

tags

public FutureData<PylonTags> tags(PylonRecording.PylonRecordingId recordingId)

Retrieve VEDO tags for a given recording. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylontags

Parameters:

recordingId - A recording id. See PylonRecording.PylonRecordingId

Returns:

vedo tags for the given filter

sample

public FutureData<PylonSample> sample(PylonSampleRequest sampleRequest)

Sample a Pylon recording. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/pylon-api-endpoints/pylonsample

Parameters:

sampleRequest - Request object containing parameters for Sample

Returns:

PylonSample object containing results of sampling