cz.srayayay.tierion.dataapi

Class V1TierionDataApiClient

java.lang.Object

cz.srayayay.tierion.dataapi.V1TierionDataApiClient

All Implemented Interfaces:

TierionDataApiClient, AutoCloseable

public class V1TierionDataApiClient
extends Object
implements TierionDataApiClient

Constructor Summary

Constructors

Constructor and Description
V1TierionDataApiClient()
V1TierionDataApiClient(Integer connectionPoolSize)
V1TierionDataApiClient(String username, String apiKey)
V1TierionDataApiClient(String username, String apiKey, Integer connectionPoolSize)

Method Summary

Modifier and Type	Method and Description
void	close()
DatastoreObject	createDatastore(DatastoreObject datastore) Creates a new datastore.
RecordObject	createRecord(long datastoreId, Map<String,String> data) Creates a new record in the specified datastore.
void	deleteDatastore(long id) Deletes an existing datastore denoted by id.
void	deleteRecord(String id) Deletes a record denoted by id.
List<DatastoreObject>	getAllDatastores() Gets a list of all datastores for the user account.
DatastoreObject	getDatastore(long id) Retrieves an existing datastore denoted by id.
RecordObject	getRecord(String id) Retrieves an existing record denoted by id.
GetRecordsResponse	getRecords(Long datastoreId, Long page, Long pageSize, Long startDate, Long endDate) Obtains a list of records from the specified datastore.
DatastoreObject	updateDatastore(long id, DatastoreObject newDatastore) Updates an existing datastore denoted by id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

V1TierionDataApiClient

public V1TierionDataApiClient(String username,
                              String apiKey,
                              Integer connectionPoolSize)

V1TierionDataApiClient

public V1TierionDataApiClient(String username,
                              String apiKey)

V1TierionDataApiClient

public V1TierionDataApiClient()

V1TierionDataApiClient

public V1TierionDataApiClient(Integer connectionPoolSize)

Method Detail

getAllDatastores

public List<DatastoreObject> getAllDatastores()

Description copied from interface: TierionDataApiClient

Gets a list of all datastores for the user account.

Specified by:

getAllDatastores in interface TierionDataApiClient

Returns:

List of all known datastores.

getDatastore

public DatastoreObject getDatastore(long id)

Description copied from interface: TierionDataApiClient

Retrieves an existing datastore denoted by id.

Specified by:

getDatastore in interface TierionDataApiClient

Parameters:

id - ID of an existing datastore to be retrieved.

createDatastore

public DatastoreObject createDatastore(DatastoreObject datastore)

Description copied from interface: TierionDataApiClient

Creates a new datastore.

Specified by:

createDatastore in interface TierionDataApiClient

Parameters:

datastore - Representation of the datastore configuration. Should contain all properties you wish to apply for the datastore.

Returns:

The returned datastore will contain the definition which was returned from the server, that means it will also contain the "id", "key" and "timestamp" properties.

deleteDatastore

public void deleteDatastore(long id)

Description copied from interface: TierionDataApiClient

Deletes an existing datastore denoted by id.

Specified by:

deleteDatastore in interface TierionDataApiClient

Parameters:

id - The ID of the datastore to be deleted.

updateDatastore

public DatastoreObject updateDatastore(long id,
                                       DatastoreObject newDatastore)

Description copied from interface: TierionDataApiClient

Updates an existing datastore denoted by id.

Specified by:

updateDatastore in interface TierionDataApiClient

Parameters:

id - The ID of the datastore to be updated.

newDatastore - Representation of the new datastore. It only needs to contain those properties which should be updated. Other properties will stay unchanged.

Returns:

getRecord

public RecordObject getRecord(String id)

Description copied from interface: TierionDataApiClient

Retrieves an existing record denoted by id.

Specified by:

getRecord in interface TierionDataApiClient

Parameters:

id - The ID of the record to be retrieved.

Returns:

getRecords

public GetRecordsResponse getRecords(Long datastoreId,
                                     Long page,
                                     Long pageSize,
                                     Long startDate,
                                     Long endDate)

Description copied from interface: TierionDataApiClient

Obtains a list of records from the specified datastore.

Specified by:

getRecords in interface TierionDataApiClient

Parameters:

datastoreId - A unique numeric identifier for the Datastore from which Records are being requested. [Required]

page - The page number of the Record results to view. If not specified, page will default to 1.

pageSize - The number of Records to include in the Record results, between 1 and 10000. If not specified, pageSize will default to 100.

startDate - A timestamp representing the start of the requested date range for the Record results. If not specified, startDate will default to creation date and time of the Datastore.

endDate - A timestamp representing the end of the requested date range for the Record results. If not specified, endDate will default to the current date and time.

Returns:

createRecord

public RecordObject createRecord(long datastoreId,
                                 Map<String,String> data)

Description copied from interface: TierionDataApiClient

Creates a new record in the specified datastore.

Specified by:

createRecord in interface TierionDataApiClient

Parameters:

datastoreId - A unique numeric identifier for the Datastore associated with this Record. [Required]

data - Key/value pairs for the Records's data.

Returns:

deleteRecord

public void deleteRecord(String id)

Description copied from interface: TierionDataApiClient

Deletes a record denoted by id.

Specified by:

deleteRecord in interface TierionDataApiClient

Parameters:

id - The ID of the record to be deleted.

close

public void close()

Specified by:

close in interface AutoCloseable