com.datasift.client.push

Class DataSiftPush

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.push.DataSiftPush

public class DataSiftPush
extends DataSiftApiClient

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
String	CREATE
String	DELETE
String	GET
String	LOG
String	PAUSE
String	PULL
String	RESUME
String	STOP
String	UPDATE
String	VALIDATE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftPush(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends PushConnector> FutureData<PushSubscription>	create(T connector, FutureData<PreparedHistoricsQuery> historics, FutureData<Stream> stream, String name)
<T extends PushConnector> FutureData<PushSubscription>	create(T connector, FutureData<PreparedHistoricsQuery> historics, FutureData<Stream> stream, String name, Status initialStatus, long start, long end) Creates a push subscription to either a historics query OR a live stream.
<T extends PushConnector> FutureData<PushSubscription>	create(T con, FutureData<PreparedHistoricsQuery> query, String name)
<T extends PushConnector> FutureData<PushSubscription>	create(T connector, PreparedHistoricsQuery historics, String name, Status initialStatus, long start, long end) Create a push subscription from a prepared query
<T extends PushConnector> FutureData<PushSubscription>	create(T con, Stream stream, String name)
<T extends PushConnector> FutureData<PushSubscription>	create(T connector, Stream stream, String name, Status initialStatus, long start, long end) Create a push subscription from a live stream
FutureData<PushSubscription>	createPull(PullJsonType type, PreparedHistoricsQuery historics, Stream stream, String name, Status initialStatus, long start, long end)
FutureData<PushSubscription>	createPull(PullJsonType jsonMeta, PreparedHistoricsQuery historics, String name)
FutureData<PushSubscription>	createPull(PullJsonType jsonMeta, PreparedHistoricsQuery historics, String name, Status initialStatus, long start, long end) Create a push subscription to be consumed via pull(PushSubscription, int, String) using a live stream
FutureData<PushSubscription>	createPull(PullJsonType jsonMeta, Stream stream, String name)
FutureData<PushSubscription>	createPull(PullJsonType jsonMeta, Stream stream, String name, Status initialStatus, long start, long end) Create a push subscription to be consumed via pull(PushSubscription, int, String) using a live stream
FutureData<DataSiftResult>	delete(String id) Delete a push subsctiption
FutureData<PushCollection>	get(HistoricsQuery historics, int page, int perPage, String orderBy, String orderDirection, boolean includeFinished) Get all push subscriptions for the given historics
FutureData<PushCollection>	get(int page, int perPage, String orderBy, String orderDirection, boolean includeFinished) Get all push subscriptions belonging to this user
FutureData<PushCollection>	get(Stream hash, int page, int perPage, String orderBy, String orderDirection, boolean includeFinished) Get all push subscriptions for the given stream
FutureData<PushSubscription>	get(String id)
FutureData<PushLogMessages>	log(String id, int page)
FutureData<PushLogMessages>	log(String id, int page, int perPage, String orderBy, String orderDirection) Retreive log messages about subscriptions
FutureData<PushSubscription>	pause(String id) Pause the push subscription with the given ID
FutureData<PulledInteractions>	pull(PushSubscription id)
FutureData<PulledInteractions>	pull(PushSubscription id, int size, String cursor) Retrieve one or more interactions from a Push queue
FutureData<PushSubscription>	resume(String id) Set a paused subscription to run again
protected void	sendPullRequest(FutureData<PulledInteractions> future, PushSubscription id, int size, String cursor, URI uri, PullReader reader)
FutureData<PushSubscription>	stop(String id) Stop/cancel a given push subscription
FutureData<PushSubscription>	update(String id, PushConnector connector)
FutureData<PushSubscription>	update(String id, PushConnector connector, String name) Updates the name or output parameters for a push sucription
<T extends PushConnector> FutureData<PushValidation>	validate(T connector) Check that the subscription details are correct

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

CREATE

public final String CREATE

See Also:

Constant Field Values

PAUSE

public final String PAUSE

See Also:

Constant Field Values

RESUME

public final String RESUME

See Also:

Constant Field Values

UPDATE

public final String UPDATE

See Also:

Constant Field Values

STOP

public final String STOP

See Also:

Constant Field Values

DELETE

public final String DELETE

See Also:

Constant Field Values

LOG

public final String LOG

See Also:

Constant Field Values

GET

public final String GET

See Also:

Constant Field Values

PULL

public final String PULL

See Also:

Constant Field Values

Constructor Detail

DataSiftPush

public DataSiftPush(DataSiftConfig config)

Method Detail

pause

public FutureData<PushSubscription> pause(String id)

Pause the push subscription with the given ID

Parameters:

id - the id of the push subscription to pause

Returns:

the push subscription that has been paused

resume

public FutureData<PushSubscription> resume(String id)

Set a paused subscription to run again

Parameters:

id - the id of the push subscription to resume

Returns:

the push subscription

stop

public FutureData<PushSubscription> stop(String id)

Stop/cancel a given push subscription

Parameters:

id - the id of the push subscription

Returns:

the subscription that was stopped

delete

public FutureData<DataSiftResult> delete(String id)

Delete a push subsctiption

Parameters:

id - the id of the subscription to delete

Returns:

a DataSiftResult which can be checked for success or failure of the request

update

public FutureData<PushSubscription> update(String id,
                                  PushConnector connector)

update

public FutureData<PushSubscription> update(String id,
                                  PushConnector connector,
                                  String name)

Updates the name or output parameters for a push sucription

Parameters:

id - the subscription ID

connector - the output parameters to update to

name - an optional name to update with

Returns:

the updated push subscription

pull

public FutureData<PulledInteractions> pull(PushSubscription id)

pull

public FutureData<PulledInteractions> pull(PushSubscription id,
                                  int size,
                                  String cursor)

Retrieve one or more interactions from a Push queue

Parameters:

id - the push subscription ID

size - max number of interactions to list

cursor - a pointer into the push

Returns:

a set of interactions pulled from the specified push queue

sendPullRequest

protected void sendPullRequest(FutureData<PulledInteractions> future,
                   PushSubscription id,
                   int size,
                   String cursor,
                   URI uri,
                   PullReader reader)

log

public FutureData<PushLogMessages> log(String id,
                              int page)

log

public FutureData<PushLogMessages> log(String id,
                              int page,
                              int perPage,
                              String orderBy,
                              String orderDirection)

Retreive log messages about subscriptions

Parameters:

id - the ID of a subscription

page - the page number

perPage - numbe rof items per page

orderBy - the field DataSift will use to order the result

orderDirection - the direction of ordering, asc or desc

Returns:

a set of log messages

get

public FutureData<PushSubscription> get(String id)

Parameters:

id - A push subscription ID

Returns:

the push subscription for the given ID

get

public FutureData<PushCollection> get(int page,
                             int perPage,
                             String orderBy,
                             String orderDirection,
                             boolean includeFinished)

Get all push subscriptions belonging to this user

Parameters:

page - a page number

perPage - the amount of items per page

orderBy - the field name to order data by e.g. created_at

orderDirection - an order, asc or desc

includeFinished - whether to included completed subscriptions or not

Returns:

an Iterable

get

public FutureData<PushCollection> get(Stream hash,
                             int page,
                             int perPage,
                             String orderBy,
                             String orderDirection,
                             boolean includeFinished)

Get all push subscriptions for the given stream

Parameters:

hash - the ID of the stream to fetch all associated push subscriptions for

page - a page number

perPage - the amount of items per page

orderBy - the field name to order data by e.g. created_at

orderDirection - an order, asc or desc

includeFinished - whether to included completed subscriptions or not

Returns:

an Iterable

get

public FutureData<PushCollection> get(HistoricsQuery historics,
                             int page,
                             int perPage,
                             String orderBy,
                             String orderDirection,
                             boolean includeFinished)

Get all push subscriptions for the given historics

Parameters:

historics - the ID of the stream to fetch all associated push subscriptions for

page - a page number

perPage - the amount of items per page

orderBy - the field name to order data by e.g. created_at

orderDirection - an order, asc or desc

includeFinished - whether to included completed subscriptions or not

Returns:

an Iterable

validate

public <T extends PushConnector> FutureData<PushValidation> validate(T connector)

Check that the subscription details are correct

Returns:

the results of the validation

create

public <T extends PushConnector> FutureData<PushSubscription> create(T connector,
                                                            FutureData<PreparedHistoricsQuery> historics,
                                                            FutureData<Stream> stream,
                                                            String name)

create

public <T extends PushConnector> FutureData<PushSubscription> create(T connector,
                                                            PreparedHistoricsQuery historics,
                                                            String name,
                                                            Status initialStatus,
                                                            long start,
                                                            long end)

Create a push subscription from a prepared query

Returns:

the created subscription

create

public <T extends PushConnector> FutureData<PushSubscription> create(T con,
                                                            FutureData<PreparedHistoricsQuery> query,
                                                            String name)

create

public <T extends PushConnector> FutureData<PushSubscription> create(T con,
                                                            Stream stream,
                                                            String name)

create

public <T extends PushConnector> FutureData<PushSubscription> create(T connector,
                                                            Stream stream,
                                                            String name,
                                                            Status initialStatus,
                                                            long start,
                                                            long end)

Create a push subscription from a live stream

Returns:

the created subscription

createPull

public FutureData<PushSubscription> createPull(PullJsonType jsonMeta,
                                      PreparedHistoricsQuery historics,
                                      String name,
                                      Status initialStatus,
                                      long start,
                                      long end)

Create a push subscription to be consumed via pull(PushSubscription, int, String) using a live stream

Parameters:

historics - the historic query which will be consumed via pull

name - a name for the subscription

initialStatus - the initial status of the subscription

start - an option timestamp of when to start the subscription

end - an optional timestamp of when to stop

Returns:

this

createPull

public FutureData<PushSubscription> createPull(PullJsonType jsonMeta,
                                      PreparedHistoricsQuery historics,
                                      String name)

createPull

public FutureData<PushSubscription> createPull(PullJsonType jsonMeta,
                                      Stream stream,
                                      String name,
                                      Status initialStatus,
                                      long start,
                                      long end)

Create a push subscription to be consumed via pull(PushSubscription, int, String) using a live stream

Parameters:

stream - the stream which will be consumed via pull

name - a name for the subscription

initialStatus - the initial status of the subscription

start - an option timestamp of when to start the subscription

end - an optional timestamp of when to stop

Returns:

this

createPull

public FutureData<PushSubscription> createPull(PullJsonType jsonMeta,
                                      Stream stream,
                                      String name)

createPull

public FutureData<PushSubscription> createPull(PullJsonType type,
                                      PreparedHistoricsQuery historics,
                                      Stream stream,
                                      String name,
                                      Status initialStatus,
                                      long start,
                                      long end)

create

public <T extends PushConnector> FutureData<PushSubscription> create(T connector,
                                                            FutureData<PreparedHistoricsQuery> historics,
                                                            FutureData<Stream> stream,
                                                            String name,
                                                            Status initialStatus,
                                                            long start,
                                                            long end)

Creates a push subscription to either a historics query OR a live stream. Of the parameters historics and stream, ONE and ONLY ONE must be null. If the push subscription is to a a live stream the historics paramer MUST be null and if the subscription is to a historics then the stream parameter MUST be null.

Parameters:

connector - a connector matching the one used in the first parameter

historics - a historics to which the subscription is being made or null if the subscription is to a live stream

stream - A live stream to which this subscription is being created or null if the subscription is to an historics query

name - a name for the subscription

initialStatus - optionally one of {active,paused,waiting_for_start}

start - optional unix timestamp, ignored if < 1 - marks the start time for a subscription, must be less than end

end - optional unix timestamp, ignored if < 1 - marks end time for a subscription, must be greater than start

Returns:

the subscription that will be created