com.coscale.sdk.client.events

Class EventsApi

java.lang.Object

com.coscale.sdk.client.events.EventsApi

public class EventsApi
extends Object

CoScale API client used to create Events and inserting event data.

Author:

cristi

Constructor Summary

Constructors

Constructor and Description
EventsApi(ApiClient api) EventsApi constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<Event>	all() all is used to get a list of all events.
List<Event>	all(Options options) all is used to get a list of all events.
List<EventData>	allData(Long eventId, Long start, Long stop) Get data from start to stop for a given event.
Msg	delete(long id) Delete a event by id.
Msg	deleteData(Long eventId, Long dataId) Delete EventData.
Event	get(long id) get a event by the id.
EventData	getData(Long eventId, Long dataId) Get a single Data point by its id.
Event	insert(EventInsert event) Insert a new event.
EventData	insertData(Long eventId, EventDataInsert data) Create new EventData for a given event.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventsApi

public EventsApi(ApiClient api)

EventsApi constructor.

Parameters:

api - ApiClient.

Method Detail

all

public List<Event> all()
                throws IOException

all is used to get a list of all events.

Returns:

List

Throws:

IOException

all

public List<Event> all(Options options)
                throws IOException

all is used to get a list of all events.

Parameters:

options - which contain query parameters

Returns:

List

Throws:

IOException

get

public Event get(long id)
          throws IOException

get a event by the id.

Parameters:

id - id of the event.

Returns:

Event

Throws:

IOException

insert

public Event insert(EventInsert event)
             throws IOException

Insert a new event.

Parameters:

event - EventInsert containing data for the new event.

Returns:

EventInsert the event object.

Throws:

IOException

delete

public Msg delete(long id)
           throws IOException

Delete a event by id.

Parameters:

id - id of the event.

Returns:

Msg the response message.

Throws:

IOException

allData

public List<EventData> allData(Long eventId,
                      @Nullable
                      Long start,
                      @Nullable
                      Long stop)
                        throws IOException

Get data from start to stop for a given event. If timestamp = 0 : use the current timestamp. If the timestamp is negative: seconds since the current timestamp. The stop time is optional. Entering only a start time will give all events from that moment onwards.

Parameters:

eventId - the event id for which the data is requested.

start - start time.

stop - stop time.

Returns:

List a list of events data.

Throws:

IOException

getData

public EventData getData(Long eventId,
                Long dataId)
                  throws IOException

Get a single Data point by its id.

Parameters:

eventId - the event id.

dataId - the event data id.

Returns:

EventData

Throws:

IOException

insertData

public EventData insertData(Long eventId,
                   EventDataInsert data)
                     throws IOException

Create new EventData for a given event.

Parameters:

eventId - the event for which the data will ne inserted.

data - EventDataInsert the data that will be inserted.

Returns:

EventData the inserted data.

Throws:

IOException

deleteData

public Msg deleteData(Long eventId,
             Long dataId)
               throws IOException

Delete EventData.

Parameters:

eventId - the event id.

dataId - the event data id.

Returns:

Msg response message.

Throws:

IOException