Package com.seeq.link.sdk.interfaces
Interface SeeqApiProvider
public interface SeeqApiProvider
Provides methods to construct Seeq API objects.
NOTE:
Each API interface is exposed separately so that they can be mocked. Because of the structure of the swagger-codegen
output, we can't just mock the ApiClient and be done with it.
-
Method Summary
Modifier and TypeMethodDescriptioncom.seeq.api.AgentsApi
An AgentsApi interface to the Seeq Server.com.seeq.api.AssetsApi
An AssetsApi interface to the Seeq Server.com.seeq.api.AuthApi
An AuthApi interface to the Seeq Server.com.seeq.api.ConditionsApi
A ConditionsApi interface to the Seeq Server.com.seeq.api.DatasourcesApi
A DatasourcesApi interface to the Seeq Server.com.seeq.api.FormulasApi
A FormulasApi interface to the Seeq Server.com.seeq.api.ItemsApi
An ItemsApi interface to the Seeq Server.com.seeq.api.JobsApi
A JobsApi interface to the Seeq Server.com.seeq.api.RequestsApi
An RequestsApi interface to the Seeq Server.com.seeq.api.ScalarsApi
A ScalarsApi interface to the Seeq Server.com.seeq.api.SignalsApi
A SignalsApi interface to the Seeq Server.com.seeq.api.SystemApi
A SystemApi interface to the Seeq Server.com.seeq.api.TreesApi
A TreesApi interface to the Seeq Server.com.seeq.api.UserGroupsApi
A UserGroupsApi interface to the Seeq Server.com.seeq.api.UsersApi
A UsersApi interface to the Seeq Server.com.seeq.ApiClient
Get an ApiClient instance for lower-level control of requests to the Seeq API.void
logout()
Logs the current client out.void
setConnectTimeout
(Duration connectTimeout) Sets a new connect timeout for the HTTP client used by the SeeqApiProvider.void
setReadTimeout
(Duration readTimeout) Sets a new read timeout for the HTTP client used by the SeeqApiProvider.void
setRetryTimeout
(Duration retryTimeout) Sets a new retry timeout for a SeeqApiProvider
-
Method Details
-
getApiClient
com.seeq.ApiClient getApiClient()Get an ApiClient instance for lower-level control of requests to the Seeq API.- Returns:
- An ApiClient instance for lower-level control of requests to the Seeq API.
-
setConnectTimeout
Sets a new connect timeout for the HTTP client used by the SeeqApiProvider. The default connect timeout is 30min.- Parameters:
connectTimeout
- The connect timeout to set
-
setReadTimeout
Sets a new read timeout for the HTTP client used by the SeeqApiProvider. The default read timeout is 30min.- Parameters:
readTimeout
- The read timeout to set
-
setRetryTimeout
Sets a new retry timeout for a SeeqApiProvider- Parameters:
retryTimeout
- Retry Timeout
-
createSignalsApi
com.seeq.api.SignalsApi createSignalsApi()A SignalsApi interface to the Seeq Server.- Returns:
- A SignalsApi interface to the Seeq Server.
-
createConditionsApi
com.seeq.api.ConditionsApi createConditionsApi()A ConditionsApi interface to the Seeq Server.- Returns:
- A ConditionsApi interface to the Seeq Server.
-
createDatasourcesApi
com.seeq.api.DatasourcesApi createDatasourcesApi()A DatasourcesApi interface to the Seeq Server.- Returns:
- A DatasourcesApi interface to the Seeq Server.
-
createItemsApi
com.seeq.api.ItemsApi createItemsApi()An ItemsApi interface to the Seeq Server.- Returns:
- An ItemsApi interface to the Seeq Server.
-
createAssetsApi
com.seeq.api.AssetsApi createAssetsApi()An AssetsApi interface to the Seeq Server.- Returns:
- An AssetsApi interface to the Seeq Server.
-
createTreesApi
com.seeq.api.TreesApi createTreesApi()A TreesApi interface to the Seeq Server.- Returns:
- A TreesApi interface to the Seeq Server.
-
createSystemApi
com.seeq.api.SystemApi createSystemApi()A SystemApi interface to the Seeq Server.- Returns:
- A SystemApi interface to the Seeq Server.
-
createAgentsApi
com.seeq.api.AgentsApi createAgentsApi()An AgentsApi interface to the Seeq Server.- Returns:
- An AgentsApi interface to the Seeq Server.
-
createAuthApi
com.seeq.api.AuthApi createAuthApi()An AuthApi interface to the Seeq Server.- Returns:
- An AuthApi interface to the Seeq Server.
-
createJobsApi
com.seeq.api.JobsApi createJobsApi()A JobsApi interface to the Seeq Server.- Returns:
- A JobsApi interface to the Seeq Server.
-
createRequestsApi
com.seeq.api.RequestsApi createRequestsApi()An RequestsApi interface to the Seeq Server.- Returns:
- An RequestsApi interface to the Seeq Server.
-
createScalarsApi
com.seeq.api.ScalarsApi createScalarsApi()A ScalarsApi interface to the Seeq Server.- Returns:
- A ScalarsApi interface to the Seeq Server.
-
createUserGroupsApi
com.seeq.api.UserGroupsApi createUserGroupsApi()A UserGroupsApi interface to the Seeq Server.- Returns:
- A UserGroupsApi interface to the Seeq Server.
-
createUsersApi
com.seeq.api.UsersApi createUsersApi()A UsersApi interface to the Seeq Server.- Returns:
- A UsersApi interface to the Seeq Server.
-
createFormulasApi
com.seeq.api.FormulasApi createFormulasApi()A FormulasApi interface to the Seeq Server.- Returns:
- A FormulasApi interface to the Seeq Server.
-
logout
void logout()Logs the current client out.
-