cz.srayayay.tierion.dataapi

Interface TierionDataApiClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

V1TierionDataApiClient

public interface TierionDataApiClient
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
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 interface java.lang.AutoCloseable

close

Method Detail

getAllDatastores

List<DatastoreObject> getAllDatastores()

Gets a list of all datastores for the user account.

Returns:

List of all known datastores.

getDatastore

DatastoreObject getDatastore(long id)

Retrieves an existing datastore denoted by id.

Parameters:

id - ID of an existing datastore to be retrieved.

createDatastore

DatastoreObject createDatastore(DatastoreObject datastore)

Creates a new datastore.

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

void deleteDatastore(long id)

Deletes an existing datastore denoted by id.

Parameters:

id - The ID of the datastore to be deleted.

updateDatastore

DatastoreObject updateDatastore(long id,
                                DatastoreObject newDatastore)

Updates an existing datastore denoted by id.

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

RecordObject getRecord(String id)

Retrieves an existing record denoted by id.

Parameters:

id - The ID of the record to be retrieved.

Returns:

getRecords

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

Obtains a list of records from the specified datastore.

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

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

Creates a new record in the specified datastore.

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

void deleteRecord(String id)

Deletes a record denoted by id.

Parameters:

id - The ID of the record to be deleted.