com.datasift.client.preview

Class DataSiftPreview

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.preview.DataSiftPreview

public class DataSiftPreview
extends DataSiftApiClient

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
String	CREATE
String	GET

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftPreview(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
FutureData<HistoricsPreview>	create(org.joda.time.DateTime start, org.joda.time.DateTime end, Stream hash, String[] params)
FutureData<HistoricsPreview>	create(org.joda.time.DateTime now, Stream stream, String[] params)
FutureData<HistoricsPreview>	create(long start, long end, Stream stream, String[] parameters) Create a historic preview for the given stream within the given time frame, using the set of parameters provided
FutureData<HistoricsPreview>	create(long start, long end, String hash, String[] parameters)
FutureData<HistoricsPreviewData>	get(HistoricsPreview preview) Get the data that's available for the given preview
FutureData<HistoricsPreviewData>	get(String id)

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

CREATE

public final String CREATE

See Also:

Constant Field Values

GET

public final String GET

See Also:

Constant Field Values

Constructor Detail

DataSiftPreview

public DataSiftPreview(DataSiftConfig config)

Method Detail

create

public FutureData<HistoricsPreview> create(org.joda.time.DateTime now,
                                  Stream stream,
                                  String[] params)

create

public FutureData<HistoricsPreview> create(org.joda.time.DateTime start,
                                  org.joda.time.DateTime end,
                                  Stream hash,
                                  String[] params)

create

public FutureData<HistoricsPreview> create(long start,
                                  long end,
                                  String hash,
                                  String[] parameters)

create

public FutureData<HistoricsPreview> create(long start,
                                  long end,
                                  Stream stream,
                                  String[] parameters)

Create a historic preview for the given stream within the given time frame, using the set of parameters provided

Parameters:

start - a timestamp of when to start the preview from

end - optionally when the preview ends - If not specified, i.e. set to a value less than 1, defaults to the earliest out of start + 24 hours or now - 1 hour.

stream - the stream/filter to create the preview for

parameters - A list of at least one but no more than 20 Historics Preview parameters e.g. target, analysis,argument see http://dev.datasift.com/docs/api/1/previewcreate for documentation of available parameters

Returns:

the preview created

get

public FutureData<HistoricsPreviewData> get(String id)

get

public FutureData<HistoricsPreviewData> get(HistoricsPreview preview)

Get the data that's available for the given preview

Parameters:

preview - the historics preview to fetch

Returns:

the data available