Package com.seeq.api

Class DatafilesApi

java.lang.Object
com.seeq.api.DatafilesApi

public class DatafilesApi extends Object
  • Constructor Details

    • DatafilesApi

      public DatafilesApi()
    • DatafilesApi

      public DatafilesApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • archiveDatafile

      public StatusMessageBase archiveDatafile(String id) throws ApiException
      Archive a datafile and all of its signals
      Parameters:
      id - ID of the datafile to archive (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • archiveDatafileWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveDatafileWithHttpInfo(String id) throws ApiException
      Archive a datafile and all of its signals
      Parameters:
      id - ID of the datafile to archive (required)
      Throws:
      ApiException - if fails to make API call
    • archiveDatafileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveDatafileWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive a datafile and all of its signals
      Parameters:
      id - ID of the datafile to archive (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createDatafile

      public DatafileOutputV1 createDatafile(DatafileInputV1 body) throws ApiException
      Create a datafile
      Parameters:
      body - Datafile information (required)
      Returns:
      DatafileOutputV1
      Throws:
      ApiException - if fails to make API call
    • createDatafileWithHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> createDatafileWithHttpInfo(DatafileInputV1 body) throws ApiException
      Create a datafile
      Parameters:
      body - Datafile information (required)
      Throws:
      ApiException - if fails to make API call
    • createDatafileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> createDatafileWithHeadersAndHttpInfo(DatafileInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a datafile
      Parameters:
      body - Datafile information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDatafile

      public DatafileOutputV1 getDatafile(String id) throws ApiException
      Get a Datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      Returns:
      DatafileOutputV1
      Throws:
      ApiException - if fails to make API call
    • getDatafileWithHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> getDatafileWithHttpInfo(String id) throws ApiException
      Get a Datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getDatafileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> getDatafileWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a Datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDatafiles

      public ItemPreviewListV1 getDatafiles(Integer offset, Integer limit) throws ApiException
      Get a collection of datafiles
      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:
      ItemPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getDatafilesWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getDatafilesWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get a collection of datafiles
      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
    • getDatafilesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getDatafilesWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of datafiles
      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
    • getItemsHostedByDatafile

      public ItemPreviewListV1 getItemsHostedByDatafile(String id, String dataId, Integer offset, Integer limit) throws ApiException
      Get a list of the items hosted by this datafile
      Parameters:
      id - ID of the datafile (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
    • getItemsHostedByDatafileWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getItemsHostedByDatafileWithHttpInfo(String id, String dataId, Integer offset, Integer limit) throws ApiException
      Get a list of the items hosted by this datafile
      Parameters:
      id - ID of the datafile (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
    • getItemsHostedByDatafileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getItemsHostedByDatafileWithHeadersAndHttpInfo(String id, String dataId, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a list of the items hosted by this datafile
      Parameters:
      id - ID of the datafile (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
    • importCSV

      public CsvDatafileOutputV1 importCSV(File file) throws ApiException
      Import a CSV file that can be used to create or update a Datafile
      Parameters:
      file - (optional)
      Returns:
      CsvDatafileOutputV1
      Throws:
      ApiException - if fails to make API call
    • importCSVWithHttpInfo

      public ApiClient.ApiResponse<CsvDatafileOutputV1> importCSVWithHttpInfo(File file) throws ApiException
      Import a CSV file that can be used to create or update a Datafile
      Parameters:
      file - (optional)
      Throws:
      ApiException - if fails to make API call
    • importCSVWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<CsvDatafileOutputV1> importCSVWithHeadersAndHttpInfo(File file, Map<String,String> customHeaders) throws ApiException
      Import a CSV file that can be used to create or update a Datafile
      Parameters:
      file - (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateDatafile

      public DatafileOutputV1 updateDatafile(String id, DatafileInputV1 body) throws ApiException
      Update a datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      body - Datafile information (required)
      Returns:
      DatafileOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateDatafileWithHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> updateDatafileWithHttpInfo(String id, DatafileInputV1 body) throws ApiException
      Update a datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      body - Datafile information (required)
      Throws:
      ApiException - if fails to make API call
    • updateDatafileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DatafileOutputV1> updateDatafileWithHeadersAndHttpInfo(String id, DatafileInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a datafile
      Parameters:
      id - ID of the datafile to retrieve (required)
      body - Datafile information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call