com.datasift.client.historics

Class DataSiftHistorics

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.historics.DataSiftHistorics

public class DataSiftHistorics
extends DataSiftApiClient

This class provides access to the DataSift Historics API.

Field Summary

Fields

Modifier and Type	Field and Description
String	DELETE
String	GET
String	PREPARE
String	START
String	STATUS
String	STOP
String	UPDATE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftHistorics(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
FutureData<DataSiftResult>	delete(PreparedHistoricsQuery query)
FutureData<DataSiftResult>	delete(String id) Delete the historic with the given ID
FutureData<HistoricsQuery>	get(String id)
FutureData<HistoricsQuery>	get(String id, boolean withEstimate) Get detailed information about a historics query
FutureData<HistoricsQueryList>	list()
FutureData<HistoricsQueryList>	list(int page)
FutureData<HistoricsQueryList>	list(int max, int page)
FutureData<HistoricsQueryList>	list(int max, int page, boolean withEstimate) Retrieve a list of HistoricsQuery objects
FutureData<PreparedHistoricsQuery>	prepare(String hash, org.joda.time.DateTime start, org.joda.time.DateTime end, String name)
FutureData<PreparedHistoricsQuery>	prepare(String hash, long start, long end, String name, int sample, String... sources)
FutureData<PreparedHistoricsQuery>	prepare(String hash, long start, long end, String name, String... sources)
FutureData<DataSiftResult>	start(FutureData<PreparedHistoricsQuery> query) Start the historics query given
FutureData<DataSiftResult>	start(PreparedHistoricsQuery query)
FutureData<DataSiftResult>	start(String id) Start the historics query with the given ID
protected FutureData<DataSiftResult>	start(String id, FutureData<DataSiftResult> f)
FutureData<HistoricsStatus>	status(org.joda.time.DateTime start, org.joda.time.DateTime end, String... sources) Check the status of data availability in our archive for the given time period
FutureData<DataSiftResult>	stop(PreparedHistoricsQuery query, String reason)
FutureData<DataSiftResult>	stop(String id, String reason) Stop a given historics query
FutureData<DataSiftResult>	update(String id, String name) Update the name of a historics query

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

PREPARE

public final String PREPARE

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

STATUS

public final String STATUS

See Also:

Constant Field Values

DELETE

public final String DELETE

See Also:

Constant Field Values

GET

public final String GET

See Also:

Constant Field Values

Constructor Detail

DataSiftHistorics

public DataSiftHistorics(DataSiftConfig config)

Method Detail

start

public FutureData<DataSiftResult> start(PreparedHistoricsQuery query)

start

public FutureData<DataSiftResult> start(FutureData<PreparedHistoricsQuery> query)

Start the historics query given

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 id)

Start the historics query with the given ID

Parameters:

id - the historics id

Returns:

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

start

protected FutureData<DataSiftResult> start(String id,
                               FutureData<DataSiftResult> f)

stop

public FutureData<DataSiftResult> stop(PreparedHistoricsQuery query,
                              String reason)

stop

public FutureData<DataSiftResult> stop(String id,
                              String reason)

Stop a given historics query

Parameters:

id - the historics ID

reason - an optional ID

Returns:

the results of calling the stop API

delete

public FutureData<DataSiftResult> delete(PreparedHistoricsQuery query)

delete

public FutureData<DataSiftResult> delete(String id)

Delete the historic with the given ID

Parameters:

id - an historic ID

Returns:

a result indicating whether the request was successful or not

update

public FutureData<DataSiftResult> update(String id,
                                String name)

Update the name of a historics query

Parameters:

id - the ID of the historics to update

name - the new name for the historics

Returns:

a result that can be used to check the success or failure of the request

status

public FutureData<HistoricsStatus> status(org.joda.time.DateTime start,
                                 org.joda.time.DateTime end,
                                 String... sources)

Check the status of data availability in our archive for the given time period

Parameters:

start - the dat from which the archive should be checked

end - the up to which the archive should be checked

sources - an optional list of data sources that should be queried, e.g. [facebook,twitter,...]

Returns:

a report of the current status/availability of data for the given time period

get

public FutureData<HistoricsQuery> get(String id)

get

public FutureData<HistoricsQuery> get(String id,
                             boolean withEstimate)

Get detailed information about a historics query

Parameters:

id - the id of the historics to list

withEstimate - if true then an estimated completion time is include in the response

Returns:

a historics query

list

public FutureData<HistoricsQueryList> list()

list

public FutureData<HistoricsQueryList> list(int max,
                                  int page)

list

public FutureData<HistoricsQueryList> list(int page)

list

public FutureData<HistoricsQueryList> list(int max,
                                  int page,
                                  boolean withEstimate)

Retrieve a list of HistoricsQuery objects

Parameters:

max - max number of objects to list

page - a page number

withEstimate - if true, include an estimated completion time

Returns:

an iterable list of HistoricsQuerys

prepare

public FutureData<PreparedHistoricsQuery> prepare(String hash,
                                         org.joda.time.DateTime start,
                                         org.joda.time.DateTime end,
                                         String name)

Parameters:

hash - The hash of the CSDL for your historics query. Example values: 2459b03a13577579bca76471778a5c3d

start - Unix timestamp for the start time. Example values: 1325548800

end - nix timestamp for the end time. Must be at least 24 in the past. Example values: 1325548800

name - The name you assign to your historics query. Example values: Football

Returns:

the prepared Historics

prepare

public FutureData<PreparedHistoricsQuery> prepare(String hash,
                                         long start,
                                         long end,
                                         String name,
                                         String... sources)

Parameters:

hash - The hash of the CSDL for your historics query. Example values: 2459b03a13577579bca76471778a5c3d

start - Unix timestamp for the start time. Example values: 1325548800

end - nix timestamp for the end time. Must be at least 24 in the past. Example values: 1325548800

name - The name you assign to your historics query. Example values: Football

sources - Comma-separated list of data sources to include. Currently, the only source you can use is twitter. In the future, you will be able to choose any source listed as a valid value that you would use in the interaction.type target. Example values: twitter

Returns:

the prepared historics

prepare

public FutureData<PreparedHistoricsQuery> prepare(String hash,
                                         long start,
                                         long end,
                                         String name,
                                         int sample,
                                         String... sources)