Package org.openapitools.client.api

Class EventsApi

java.lang.Object

org.openapitools.client.api.EventsApi

public class EventsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
EventsApi()
EventsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
EventReturn	getEvents(String trDataset, GetEventsData getEventsData)	Get events for the dataset Get events for the dataset Get events for the auth'ed user.
okhttp3.Call	getEventsAsync(String trDataset, GetEventsData getEventsData, ApiCallback<EventReturn> _callback)	Get events for the dataset (asynchronously) Get events for the dataset Get events for the auth'ed user.
okhttp3.Call	getEventsCall(String trDataset, GetEventsData getEventsData, ApiCallback _callback)	Build call for getEvents
ApiResponse<EventReturn>	getEventsWithHttpInfo(@NotNull String trDataset, @NotNull GetEventsData getEventsData)	Get events for the dataset Get events for the dataset Get events for the auth'ed user.
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventsApi

public EventsApi()

EventsApi

public EventsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getEventsCall

public okhttp3.Call getEventsCall(String trDataset,
                                  GetEventsData getEventsData,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getEvents

Parameters:

trDataset - The dataset id to use for the request (required)

getEventsData - JSON request payload to get events for a dataset (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Events for the dataset	-
400	Service error relating to getting events for the dataset	-

getEvents

public EventReturn getEvents(String trDataset,
                             GetEventsData getEventsData)
                      throws ApiException

Get events for the dataset Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.

Parameters:

trDataset - The dataset id to use for the request (required)

getEventsData - JSON request payload to get events for a dataset (required)

Returns:

EventReturn

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Events for the dataset	-
400	Service error relating to getting events for the dataset	-

getEventsWithHttpInfo

public ApiResponse<EventReturn> getEventsWithHttpInfo(@NotNull
                                                      @NotNull String trDataset,
                                                      @NotNull
                                                      @NotNull GetEventsData getEventsData)
                                               throws ApiException

Get events for the dataset Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.

Parameters:

trDataset - The dataset id to use for the request (required)

getEventsData - JSON request payload to get events for a dataset (required)

Returns:

ApiResponse<EventReturn>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Events for the dataset	-
400	Service error relating to getting events for the dataset	-

getEventsAsync

public okhttp3.Call getEventsAsync(String trDataset,
                                   GetEventsData getEventsData,
                                   ApiCallback<EventReturn> _callback)
                            throws ApiException

Get events for the dataset (asynchronously) Get events for the dataset Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.

Parameters:

trDataset - The dataset id to use for the request (required)

getEventsData - JSON request payload to get events for a dataset (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Events for the dataset	-
400	Service error relating to getting events for the dataset	-