Package com.seeq.api

Class PluginsApi

java.lang.Object
com.seeq.api.PluginsApi

public class PluginsApi extends Object
  • Constructor Details

    • PluginsApi

      public PluginsApi()
    • PluginsApi

      public PluginsApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • deletePlugin

      public StatusMessageBase deletePlugin(String id) throws ApiException
      Delete a plugin
      Parameters:
      id - The ID of the plugin (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • deletePluginWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deletePluginWithHttpInfo(String id) throws ApiException
      Delete a plugin
      Parameters:
      id - The ID of the plugin (required)
      Throws:
      ApiException - if fails to make API call
    • deletePluginWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deletePluginWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Delete a plugin
      Parameters:
      id - The ID of the plugin (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getFile

      public void getFile(String id, String fileName) throws ApiException
      Get a plugin file
      Parameters:
      id - The ID of the plugin (required)
      fileName - The name of the file from the plugin (required)
      Throws:
      ApiException - if fails to make API call
    • getFileWithHttpInfo

      public void getFileWithHttpInfo(String id, String fileName) throws ApiException
      Get a plugin file
      Parameters:
      id - The ID of the plugin (required)
      fileName - The name of the file from the plugin (required)
      Throws:
      ApiException - if fails to make API call
    • getFileWithHeadersAndHttpInfo

      public void getFileWithHeadersAndHttpInfo(String id, String fileName, Map<String,String> customHeaders) throws ApiException
      Get a plugin file
      Parameters:
      id - The ID of the plugin (required)
      fileName - The name of the file from the plugin (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getPlugins

      public PluginOutputListV1 getPlugins(String nameSearch, String identifierSearch, String categorySearch, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of plugins
      Parameters:
      nameSearch - Search text by which to filter plugins' names. (optional)
      identifierSearch - Search text by which to filter plugins' identifiers. (optional)
      categorySearch - Search text by which to filter plugins' categories. (optional)
      sortOrder - A field by which to order the plugins followed by a space and 'asc' or 'desc'. Field name can be one of: name, identifier, category (optional, default to name asc)
      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:
      PluginOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getPluginsWithHttpInfo

      public ApiClient.ApiResponse<PluginOutputListV1> getPluginsWithHttpInfo(String nameSearch, String identifierSearch, String categorySearch, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of plugins
      Parameters:
      nameSearch - Search text by which to filter plugins' names. (optional)
      identifierSearch - Search text by which to filter plugins' identifiers. (optional)
      categorySearch - Search text by which to filter plugins' categories. (optional)
      sortOrder - A field by which to order the plugins followed by a space and 'asc' or 'desc'. Field name can be one of: name, identifier, category (optional, default to name asc)
      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
    • getPluginsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<PluginOutputListV1> getPluginsWithHeadersAndHttpInfo(String nameSearch, String identifierSearch, String categorySearch, String sortOrder, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of plugins
      Parameters:
      nameSearch - Search text by which to filter plugins' names. (optional)
      identifierSearch - Search text by which to filter plugins' identifiers. (optional)
      categorySearch - Search text by which to filter plugins' categories. (optional)
      sortOrder - A field by which to order the plugins followed by a space and 'asc' or 'desc'. Field name can be one of: name, identifier, category (optional, default to name asc)
      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
    • uploadPlugin

      public StatusMessageBase uploadPlugin(File file, Boolean inDevelopment) throws ApiException
      Upload a plugin
      Parameters:
      file - (optional)
      inDevelopment - Whether this item is in Development Mode, meaning that it is not allowed to be shared with any other users. Non-administrators may only install Plugins in Development Mode. (optional, default to false)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • uploadPluginWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> uploadPluginWithHttpInfo(File file, Boolean inDevelopment) throws ApiException
      Upload a plugin
      Parameters:
      file - (optional)
      inDevelopment - Whether this item is in Development Mode, meaning that it is not allowed to be shared with any other users. Non-administrators may only install Plugins in Development Mode. (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • uploadPluginWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> uploadPluginWithHeadersAndHttpInfo(File file, Boolean inDevelopment, Map<String,String> customHeaders) throws ApiException
      Upload a plugin
      Parameters:
      file - (optional)
      inDevelopment - Whether this item is in Development Mode, meaning that it is not allowed to be shared with any other users. Non-administrators may only install Plugins in Development Mode. (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call