Package com.seeq.api
Class DatasourcesApi
java.lang.Object
com.seeq.api.DatasourcesApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionArchive a datasourcearchiveDatasourceWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a datasourceArchive a datasourcecleanUp
(String id, DatasourceCleanUpInputV1 body) Archive stale hosted itemscleanUpWithHeadersAndHttpInfo
(String id, DatasourceCleanUpInputV1 body, Map<String, String> customHeaders) Archive stale hosted itemsArchive stale hosted itemsCreate a datasourcecreateDatasourceWithHeadersAndHttpInfo
(DatasourceInputV1 body, Map<String, String> customHeaders) Create a datasourceCreate a datasourceDisable all connections associated with a datasourcedisableConnectionsWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Disable all connections associated with a datasourceDisable all connections associated with a datasourceArchive a datasource and all items hosted by the datasourcefullyArchiveDatasourceWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a datasource and all items hosted by the datasourceArchive a datasource and all items hosted by the datasourcegetDatasource
(String id) Get a DatasourcegetDatasources
(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived) Get a collection of datasourcesgetDatasourcesWithHeadersAndHttpInfo
(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived, Map<String, String> customHeaders) Get a collection of datasourcesgetDatasourcesWithHttpInfo
(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived) Get a collection of datasourcesgetDatasourceWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a DatasourceGet a DatasourcegetItemsHostedByDatasource
(String id, String dataId, Integer offset, Integer limit) Get a list of the items hosted by this datasourcegetItemsHostedByDatasourceWithHeadersAndHttpInfo
(String id, String dataId, Integer offset, Integer limit, Map<String, String> customHeaders) Get a list of the items hosted by this datasourcegetItemsHostedByDatasourceWithHttpInfo
(String id, String dataId, Integer offset, Integer limit) Get a list of the items hosted by this datasourcelong
Get statistics describing the health of remote datasourcesGet statistics describing the health of remote datasourcesgetStatusWithHttpInfo
(Integer offset, Integer limit) Get statistics describing the health of remote datasourcesRecount item totals for a datasource.recountWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Recount item totals for a datasource.Recount item totals for a datasource.void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout)
-
Constructor Details
-
DatasourcesApi
public DatasourcesApi() -
DatasourcesApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveDatasource
Archive a datasource- Parameters:
id
- ID of the datasource to delete (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
archiveDatasourceWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveDatasourceWithHttpInfo(String id) throws ApiException Archive a datasource- Parameters:
id
- ID of the datasource to delete (required)- Throws:
ApiException
- if fails to make API call
-
archiveDatasourceWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveDatasourceWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a datasource- Parameters:
id
- ID of the datasource to delete (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
cleanUp
public DatasourceCleanUpOutputV1 cleanUp(String id, DatasourceCleanUpInputV1 body) throws ApiException Archive stale hosted items- Parameters:
id
- ID of the datasource to clean up (required)body
- Input parameters for the Datasource clean-up process (required)- Returns:
- DatasourceCleanUpOutputV1
- Throws:
ApiException
- if fails to make API call
-
cleanUpWithHttpInfo
public ApiClient.ApiResponse<DatasourceCleanUpOutputV1> cleanUpWithHttpInfo(String id, DatasourceCleanUpInputV1 body) throws ApiException Archive stale hosted items- Parameters:
id
- ID of the datasource to clean up (required)body
- Input parameters for the Datasource clean-up process (required)- Throws:
ApiException
- if fails to make API call
-
cleanUpWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceCleanUpOutputV1> cleanUpWithHeadersAndHttpInfo(String id, DatasourceCleanUpInputV1 body, Map<String, String> customHeaders) throws ApiExceptionArchive stale hosted items- Parameters:
id
- ID of the datasource to clean up (required)body
- Input parameters for the Datasource clean-up process (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createDatasource
Create a datasource- Parameters:
body
- Datasource information (required)- Returns:
- DatasourceOutputV1
- Throws:
ApiException
- if fails to make API call
-
createDatasourceWithHttpInfo
public ApiClient.ApiResponse<DatasourceOutputV1> createDatasourceWithHttpInfo(DatasourceInputV1 body) throws ApiException Create a datasource- Parameters:
body
- Datasource information (required)- Throws:
ApiException
- if fails to make API call
-
createDatasourceWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceOutputV1> createDatasourceWithHeadersAndHttpInfo(DatasourceInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a datasource- Parameters:
body
- Datasource information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
disableConnections
Disable all connections associated with a datasource- Parameters:
id
- ID of the datasource (required)- Returns:
- ConnectionsOutputV1
- Throws:
ApiException
- if fails to make API call
-
disableConnectionsWithHttpInfo
public ApiClient.ApiResponse<ConnectionsOutputV1> disableConnectionsWithHttpInfo(String id) throws ApiException Disable all connections associated with a datasource- Parameters:
id
- ID of the datasource (required)- Throws:
ApiException
- if fails to make API call
-
disableConnectionsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ConnectionsOutputV1> disableConnectionsWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionDisable all connections associated with a datasource- Parameters:
id
- ID of the datasource (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
fullyArchiveDatasource
Archive a datasource and all items hosted by the datasource- Parameters:
id
- ID of the datasource to archive (required)- Returns:
- JobAcceptedOutputV1
- Throws:
ApiException
- if fails to make API call
-
fullyArchiveDatasourceWithHttpInfo
public ApiClient.ApiResponse<JobAcceptedOutputV1> fullyArchiveDatasourceWithHttpInfo(String id) throws ApiException Archive a datasource and all items hosted by the datasource- Parameters:
id
- ID of the datasource to archive (required)- Throws:
ApiException
- if fails to make API call
-
fullyArchiveDatasourceWithHeadersAndHttpInfo
public ApiClient.ApiResponse<JobAcceptedOutputV1> fullyArchiveDatasourceWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a datasource and all items hosted by the datasource- Parameters:
id
- ID of the datasource to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getDatasource
Get a Datasource- Parameters:
id
- ID of the datasource to retrieve (required)- Returns:
- DatasourceOutputV1
- Throws:
ApiException
- if fails to make API call
-
getDatasourceWithHttpInfo
public ApiClient.ApiResponse<DatasourceOutputV1> getDatasourceWithHttpInfo(String id) throws ApiException Get a Datasource- Parameters:
id
- ID of the datasource to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getDatasourceWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceOutputV1> getDatasourceWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a Datasource- Parameters:
id
- ID of the datasource to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getDatasources
public DatasourceOutputListV1 getDatasources(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived) throws ApiException Get a collection of datasources- Parameters:
datasourceClass
- The datasource class, the name of the underlying source, 'CSV File' for example, not specifying this parameter will return datasources of any class (optional)datasourceId
- The datasource ID, an identifier that distinguishes a datasource from others of the same datasource class, 'timeseries/salt' for example, not specifying this parameter will return datasources of any ID (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeArchived
- Whether archived datasources should be included (optional, default to false)- Returns:
- DatasourceOutputListV1
- Throws:
ApiException
- if fails to make API call
-
getDatasourcesWithHttpInfo
public ApiClient.ApiResponse<DatasourceOutputListV1> getDatasourcesWithHttpInfo(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived) throws ApiException Get a collection of datasources- Parameters:
datasourceClass
- The datasource class, the name of the underlying source, 'CSV File' for example, not specifying this parameter will return datasources of any class (optional)datasourceId
- The datasource ID, an identifier that distinguishes a datasource from others of the same datasource class, 'timeseries/salt' for example, not specifying this parameter will return datasources of any ID (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeArchived
- Whether archived datasources should be included (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
getDatasourcesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceOutputListV1> getDatasourcesWithHeadersAndHttpInfo(String datasourceClass, String datasourceId, Integer offset, Integer limit, Boolean includeArchived, Map<String, String> customHeaders) throws ApiExceptionGet a collection of datasources- Parameters:
datasourceClass
- The datasource class, the name of the underlying source, 'CSV File' for example, not specifying this parameter will return datasources of any class (optional)datasourceId
- The datasource ID, an identifier that distinguishes a datasource from others of the same datasource class, 'timeseries/salt' for example, not specifying this parameter will return datasources of any ID (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeArchived
- Whether archived datasources should be included (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getItemsHostedByDatasource
public ItemPreviewListV1 getItemsHostedByDatasource(String id, String dataId, Integer offset, Integer limit) throws ApiException Get a list of the items hosted by this datasource- Parameters:
id
- ID of the datasource (required)dataId
- The dataId for a specific hosted item (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ItemPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getItemsHostedByDatasourceWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getItemsHostedByDatasourceWithHttpInfo(String id, String dataId, Integer offset, Integer limit) throws ApiException Get a list of the items hosted by this datasource- Parameters:
id
- ID of the datasource (required)dataId
- The dataId for a specific hosted item (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getItemsHostedByDatasourceWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getItemsHostedByDatasourceWithHeadersAndHttpInfo(String id, String dataId, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a list of the items hosted by this datasource- Parameters:
id
- ID of the datasource (required)dataId
- The dataId for a specific hosted item (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getStatus
Get statistics describing the health of remote datasources- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- DatasourceStatusOutputV1
- Throws:
ApiException
- if fails to make API call
-
getStatusWithHttpInfo
public ApiClient.ApiResponse<DatasourceStatusOutputV1> getStatusWithHttpInfo(Integer offset, Integer limit) throws ApiException Get statistics describing the health of remote datasources- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getStatusWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceStatusOutputV1> getStatusWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet statistics describing the health of remote datasources- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
recount
Recount item totals for a datasource. Do not run while datasource is indexing- Parameters:
id
- ID of the datasource to recount (required)- Returns:
- DatasourceOutputV1
- Throws:
ApiException
- if fails to make API call
-
recountWithHttpInfo
Recount item totals for a datasource. Do not run while datasource is indexing- Parameters:
id
- ID of the datasource to recount (required)- Throws:
ApiException
- if fails to make API call
-
recountWithHeadersAndHttpInfo
public ApiClient.ApiResponse<DatasourceOutputV1> recountWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionRecount item totals for a datasource. Do not run while datasource is indexing- Parameters:
id
- ID of the datasource to recount (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-