io.instacount.client

Interface Instacount

All Known Subinterfaces:

Instacount.InstacountFeign

public interface Instacount

A feign client for interacting with the Instacount API.

See Also:

"https://www.instacount.io", "https://instacount.readme.io/docs/api-clients"

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Instacount.Builder A class for building instances of Instacount.
static interface	Instacount.InstacountFeign The feign interface for the Instacount client.

Method Summary

Methods

Modifier and Type	Method and Description
CreateShardedCounterResponse	createShardedCounter() Creates a new counter with a count of zero (0) and a unique "name" provided by Instacount.
CreateShardedCounterResponse	createShardedCounter(CreateShardedCounterInput createCounterInput) Creates a new counter using data from the specified createCounterInput.
DecrementShardedCounterResponse	decrementShardedCounter(String counterName) Decrements the counter named counterName by 1.
DecrementShardedCounterResponse	decrementShardedCounter(String counterName, DecrementShardedCounterInput decrementCounterInput) Decrements the counter named counterName by the amount specified in amount, using the specified async characteristics..
DeleteShardedCounterResponse	deleteShardedCounter(String counterName) Creates a new counter using data from the specified createCounterInput.
GetShardedCounterResponse	getShardedCounter(String counterName) Gets the counter with the specified counterName from the Instacount API.
GetShardedCounterOperationResponse	getShardedCounterOperation(String counterName, Integer shardIndex, String operationId) Get the ShardedCounterOperation for the specified inputs.
IncrementShardedCounterResponse	incrementShardedCounter(String counterName) Increments the counter named counterName by 1.
IncrementShardedCounterResponse	incrementShardedCounter(String counterName, IncrementShardedCounterInput incrementCounterInput) Increments the counter named counterName by the amount specified in amount, using the specified async characteristics..
UpdateShardedCounterResponse	updateShardedCounter(String counterName, UpdateShardedCounterInput updateCounterInput) Creates a new counter using data from the specified createCounterInput.

Method Detail

createShardedCounter

CreateShardedCounterResponse createShardedCounter()
                                                  throws InstacountClientException

Creates a new counter with a count of zero (0) and a unique "name" provided by Instacount.

Throws:

InstacountClientException

createShardedCounter

CreateShardedCounterResponse createShardedCounter(CreateShardedCounterInput createCounterInput)
                                                  throws InstacountClientException

Creates a new counter using data from the specified createCounterInput.

Parameters:

createCounterInput - An instance of CreateShardedCounterInput.

Throws:

InstacountClientException

getShardedCounter

GetShardedCounterResponse getShardedCounter(String counterName)
                                            throws InstacountClientException

Gets the counter with the specified counterName from the Instacount API.

Parameters:

counterName - A String representing the name of the ShardedCounter resource.

Throws:

InstacountClientException

updateShardedCounter

UpdateShardedCounterResponse updateShardedCounter(String counterName,
                                                UpdateShardedCounterInput updateCounterInput)
                                                  throws InstacountClientException

Creates a new counter using data from the specified createCounterInput.

Parameters:

counterName - A String representing the name of the ShardedCounter resource.

updateCounterInput - An instance of UpdateShardedCounterInput.

Throws:

InstacountClientException

deleteShardedCounter

DeleteShardedCounterResponse deleteShardedCounter(String counterName)
                                                  throws InstacountClientException

Creates a new counter using data from the specified createCounterInput.

Parameters:

counterName - A String representing the name of the ShardedCounter resource.

Throws:

InstacountClientException

incrementShardedCounter

IncrementShardedCounterResponse incrementShardedCounter(String counterName)
                                                        throws InstacountClientException

Increments the counter named counterName by 1.

Parameters:

counterName -

Throws:

InstacountClientException

decrementShardedCounter

DecrementShardedCounterResponse decrementShardedCounter(String counterName)
                                                        throws InstacountClientException

Decrements the counter named counterName by 1.

Parameters:

counterName -

Throws:

InstacountClientException

incrementShardedCounter

IncrementShardedCounterResponse incrementShardedCounter(String counterName,
                                                      IncrementShardedCounterInput incrementCounterInput)
                                                        throws InstacountClientException

Increments the counter named counterName by the amount specified in amount, using the specified async characteristics..

Parameters:

counterName - A String representing the name of the counter to incrementShardedCounter.

incrementCounterInput - An instance of IncrementShardedCounterInput for shaping the operation.

Throws:

InstacountClientException

decrementShardedCounter

DecrementShardedCounterResponse decrementShardedCounter(String counterName,
                                                      DecrementShardedCounterInput decrementCounterInput)
                                                        throws InstacountClientException

Decrements the counter named counterName by the amount specified in amount, using the specified async characteristics..

Parameters:

counterName - A String representing the name of the counter to decrementShardedCounter.

decrementCounterInput - An instance of DecrementShardedCounterInput for shaping the operation.

Throws:

InstacountClientException

getShardedCounterOperation

GetShardedCounterOperationResponse getShardedCounterOperation(String counterName,
                                                            Integer shardIndex,
                                                            String operationId)
                                                              throws InstacountClientException

Get the ShardedCounterOperation for the specified inputs.

Parameters:

counterName - A String representing the name of the counter resource.

shardIndex - The 0-based index of the shard this operation was performed against.

operationId - A String representing the unique identifier of the operation being requested.

Throws:

InstacountClientException