com.datasift.client.accounts

Class DataSiftAccount

java.lang.Object

com.datasift.client.DataSiftApiClient

com.datasift.client.accounts.DataSiftAccount

public class DataSiftAccount
extends DataSiftApiClient

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
String	IDENTITY
String	USAGE

Fields inherited from class com.datasift.client.DataSiftApiClient

config

Constructor Summary

Constructors

Constructor and Description
DataSiftAccount(DataSiftConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
FutureData<Identity>	create(String label)
FutureData<Identity>	create(String label, boolean active)
FutureData<Identity>	create(String label, boolean active, boolean master) Create a new Identity
FutureData<Limit>	createLimit(String identity, String service, Long allowance) Create a Limit
FutureData<Token>	createToken(String identity, String service, String token) Create a new token
FutureData<DataSiftResult>	delete(String id) Delete an Identity using it's ID
FutureData<DataSiftResult>	deleteLimit(String identity, String service) Delete a limit
FutureData<DataSiftResult>	deleteToken(String identity, String service) Delete a service token
FutureData<Identity>	get(String id) Fetch an Identity using it's ID
FutureData<Limit>	getLimit(String identity, String service) Fetch a Limit
FutureData<Token>	getToken(String identity, String service) Fetch a token using it's service ID and it's Identity's ID
FutureData<UsageResult>	getUsage(String period, int start, int end) Get the usage for the current account.
FutureData<IdentityList>	list()
FutureData<IdentityList>	list(int page)
FutureData<IdentityList>	list(int page, int perPage)
FutureData<IdentityList>	list(String label)
FutureData<IdentityList>	list(String label, int page)
FutureData<IdentityList>	list(String label, int page, int perPage) List identities with a given label and page details
FutureData<LimitList>	listLimits(String service)
FutureData<LimitList>	listLimits(String service, int page)
FutureData<LimitList>	listLimits(String service, int page, int perPage) List limits for the given service
FutureData<TokenList>	listTokens(String identity)
FutureData<TokenList>	listTokens(String identity, int page)
FutureData<TokenList>	listTokens(String identity, int page, int perPage) List tokens associated with an identity
FutureData<Identity>	update(String id, String label, Boolean active, Boolean master) Update an existing identity with values
FutureData<Limit>	updateLimit(String identity, String service, Long allowance) Update a token
FutureData<Token>	updateToken(String identity, String service, String token) Update a token

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

IDENTITY

public final String IDENTITY

See Also:

Constant Field Values

USAGE

public final String USAGE

See Also:

Constant Field Values

Constructor Detail

DataSiftAccount

public DataSiftAccount(DataSiftConfig config)

Method Detail

create

public FutureData<Identity> create(String label)

create

public FutureData<Identity> create(String label,
                          boolean active)

create

public FutureData<Identity> create(String label,
                          boolean active,
                          boolean master)

Create a new Identity

Parameters:

label - text label to tag the identity with

active - whether the identity is active

master - if the identity is a master identity

Returns:

Newly created Identity

update

public FutureData<Identity> update(String id,
                          String label,
                          Boolean active,
                          Boolean master)

Update an existing identity with values

Parameters:

id - target to update

label - new label (may be null otherwise)

active - new activity (may be null otherwise)

master - new master (may be null otherwise)

Returns:

The new updated Identity

list

public FutureData<IdentityList> list()

list

public FutureData<IdentityList> list(String label)

list

public FutureData<IdentityList> list(int page)

list

public FutureData<IdentityList> list(String label,
                            int page)

list

public FutureData<IdentityList> list(int page,
                            int perPage)

list

public FutureData<IdentityList> list(String label,
                            int page,
                            int perPage)

List identities with a given label and page details

Parameters:

label - which label you'd like to list (can be null)

page - page number (can be 0)

perPage - items per page (can be 0)

Returns:

List of identities

get

public FutureData<Identity> get(String id)

Fetch an Identity using it's ID

Parameters:

id - the ID of the identity to fetch

Returns:

The identity for the ID provided

delete

public FutureData<DataSiftResult> delete(String id)

Delete an Identity using it's ID

Parameters:

id - the ID of the identity to delete

Returns:

Success or failure

listTokens

public FutureData<TokenList> listTokens(String identity)

listTokens

public FutureData<TokenList> listTokens(String identity,
                               int page)

listTokens

public FutureData<TokenList> listTokens(String identity,
                               int page,
                               int perPage)

List tokens associated with an identity

Parameters:

identity - which identity you want to list the tokens of

page - page number (can be 0)

perPage - items per page (can be 0)

Returns:

List of identities

getToken

public FutureData<Token> getToken(String identity,
                         String service)

Fetch a token using it's service ID and it's Identity's ID

Parameters:

identity - the ID of the identity to query

service - the service of the token to fetch

Returns:

The identity for the ID provided

createToken

public FutureData<Token> createToken(String identity,
                            String service,
                            String token)

Create a new token

Parameters:

identity - identity to store this token under

service - service name to give this token

token - token

Returns:

Created Token

deleteToken

public FutureData<DataSiftResult> deleteToken(String identity,
                                     String service)

Delete a service token

Parameters:

identity - identity to delete the token from

service - service to delete the token from

Returns:

Success of deletion

updateToken

public FutureData<Token> updateToken(String identity,
                            String service,
                            String token)

Update a token

Parameters:

identity - identity to update a token inside

service - service to update the token for

token - new token value

Returns:

The updated Token

getLimit

public FutureData<Limit> getLimit(String identity,
                         String service)

Fetch a Limit

Parameters:

identity - the ID of the identity

service - the name of the service

Returns:

The limit for the service in that identity

createLimit

public FutureData<Limit> createLimit(String identity,
                            String service,
                            Long allowance)

Create a Limit

Parameters:

identity - ID of the identity to store the limit in

service - service to set the limit for

allowance - allowance to store in the limit

Returns:

Created limit

listLimits

public FutureData<LimitList> listLimits(String service)

listLimits

public FutureData<LimitList> listLimits(String service,
                               int page)

listLimits

public FutureData<LimitList> listLimits(String service,
                               int page,
                               int perPage)

List limits for the given service

Parameters:

service - which service you want to list the limits of

page - page number (can be 0)

perPage - items per page (can be 0)

Returns:

List of identities

deleteLimit

public FutureData<DataSiftResult> deleteLimit(String identity,
                                     String service)

Delete a limit

Parameters:

identity - identity to delete the limit from

service - service to delete the limit from

Returns:

Success of deletion

updateLimit

public FutureData<Limit> updateLimit(String identity,
                            String service,
                            Long allowance)

Update a token

Parameters:

identity - identity to update a token inside

service - service to update the token for

allowance - new limit value

Returns:

The updated Token

getUsage

public FutureData<UsageResult> getUsage(String period,
                               int start,
                               int end)

Get the usage for the current account. Period can be "hourly", "daily" or "monthly", and is optional. If start timestamp is set to 0, start time is calculated based on a single unit of the period passed in. i.e if the period is daily, this will be one day prior to the end timestamp. If end timestamp is set to 0, end time is defaulted to current time. For information on this endpoint see documentation page: http://dev.datasift.com/pylon/docs/api/acct-api-endpoints

Parameters:

period - the frequency at which to report usage data within the query period

start - POSIX timestamp representing the time from which to report usage

end - POSIX timestamp representing the latest time at which to report usage

Returns:

Usage information in the form of a list of Usage objects