Package com.seeq.api

Class SystemApi

java.lang.Object
com.seeq.api.SystemApi

public class SystemApi extends Object
  • Constructor Details

    • SystemApi

      public SystemApi()
    • SystemApi

      public SystemApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • createAddOnTool

      public AddOnToolOutputV1 createAddOnTool(AddOnToolInputV1 body) throws ApiException
      Create an add-on tool
      Parameters:
      body - Add-on tool information (required)
      Returns:
      AddOnToolOutputV1
      Throws:
      ApiException - if fails to make API call
    • createAddOnToolWithHttpInfo

      public ApiClient.ApiResponse<AddOnToolOutputV1> createAddOnToolWithHttpInfo(AddOnToolInputV1 body) throws ApiException
      Create an add-on tool
      Parameters:
      body - Add-on tool information (required)
      Throws:
      ApiException - if fails to make API call
    • createAddOnToolWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AddOnToolOutputV1> createAddOnToolWithHeadersAndHttpInfo(AddOnToolInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create an add-on tool
      Parameters:
      body - Add-on tool information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteAddOnTool

      public StatusMessageBase deleteAddOnTool(String id) throws ApiException
      Delete an add-on tool
      Parameters:
      id - ID of the add-on to delete (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • deleteAddOnToolWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deleteAddOnToolWithHttpInfo(String id) throws ApiException
      Delete an add-on tool
      Parameters:
      id - ID of the add-on to delete (required)
      Throws:
      ApiException - if fails to make API call
    • deleteAddOnToolWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deleteAddOnToolWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Delete an add-on tool
      Parameters:
      id - ID of the add-on to delete (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • disableLicensedFeature

      public void disableLicensedFeature(String name) throws ApiException
      Disable a licensed feature until the next server shutdown.
      Parameters:
      name - The name of the licensed feature (required)
      Throws:
      ApiException - if fails to make API call
    • disableLicensedFeatureWithHttpInfo

      public void disableLicensedFeatureWithHttpInfo(String name) throws ApiException
      Disable a licensed feature until the next server shutdown.
      Parameters:
      name - The name of the licensed feature (required)
      Throws:
      ApiException - if fails to make API call
    • disableLicensedFeatureWithHeadersAndHttpInfo

      public void disableLicensedFeatureWithHeadersAndHttpInfo(String name, Map<String,String> customHeaders) throws ApiException
      Disable a licensed feature until the next server shutdown.
      Parameters:
      name - The name of the licensed feature (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • enableLicensedFeature

      public void enableLicensedFeature(String name) throws ApiException
      Re-enable a licensed feature that was previously disabled. If the feature does not have a valid license or was not previously disabled, this will do nothing.
      Parameters:
      name - The name of the licensed feature (required)
      Throws:
      ApiException - if fails to make API call
    • enableLicensedFeatureWithHttpInfo

      public void enableLicensedFeatureWithHttpInfo(String name) throws ApiException
      Re-enable a licensed feature that was previously disabled. If the feature does not have a valid license or was not previously disabled, this will do nothing.
      Parameters:
      name - The name of the licensed feature (required)
      Throws:
      ApiException - if fails to make API call
    • enableLicensedFeatureWithHeadersAndHttpInfo

      public void enableLicensedFeatureWithHeadersAndHttpInfo(String name, Map<String,String> customHeaders) throws ApiException
      Re-enable a licensed feature that was previously disabled. If the feature does not have a valid license or was not previously disabled, this will do nothing.
      Parameters:
      name - The name of the licensed feature (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAddOnTools

      public GetAddOnToolsOutputV1 getAddOnTools() throws ApiException
      Gets a list of all add-on tools.
      Returns:
      GetAddOnToolsOutputV1
      Throws:
      ApiException - if fails to make API call
    • getAddOnToolsWithHttpInfo

      public ApiClient.ApiResponse<GetAddOnToolsOutputV1> getAddOnToolsWithHttpInfo() throws ApiException
      Gets a list of all add-on tools.
      Throws:
      ApiException - if fails to make API call
    • getAddOnToolsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<GetAddOnToolsOutputV1> getAddOnToolsWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Gets a list of all add-on tools.
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAdministratorContactInformation

      public AdministratorContactInformationV1 getAdministratorContactInformation() throws ApiException
      Get the system administrator's contact information
      Returns:
      AdministratorContactInformationV1
      Throws:
      ApiException - if fails to make API call
    • getAdministratorContactInformationWithHttpInfo

      public ApiClient.ApiResponse<AdministratorContactInformationV1> getAdministratorContactInformationWithHttpInfo() throws ApiException
      Get the system administrator's contact information
      Throws:
      ApiException - if fails to make API call
    • getAdministratorContactInformationWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AdministratorContactInformationV1> getAdministratorContactInformationWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get the system administrator's contact information
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAgentKey

      public AgentKeyOutputV1 getAgentKey() throws ApiException
      Used to retrieve the value of the Seeq server agent.key
      Returns:
      AgentKeyOutputV1
      Throws:
      ApiException - if fails to make API call
    • getAgentKeyWithHttpInfo

      public ApiClient.ApiResponse<AgentKeyOutputV1> getAgentKeyWithHttpInfo() throws ApiException
      Used to retrieve the value of the Seeq server agent.key
      Throws:
      ApiException - if fails to make API call
    • getAgentKeyWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AgentKeyOutputV1> getAgentKeyWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Used to retrieve the value of the Seeq server agent.key
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getBuildInfo

      public ServerBuildInfoOutputV1 getBuildInfo() throws ApiException
      Used to determine the precise revision of this Seeq build
      Returns:
      ServerBuildInfoOutputV1
      Throws:
      ApiException - if fails to make API call
    • getBuildInfoWithHttpInfo

      public ApiClient.ApiResponse<ServerBuildInfoOutputV1> getBuildInfoWithHttpInfo() throws ApiException
      Used to determine the precise revision of this Seeq build
      Throws:
      ApiException - if fails to make API call
    • getBuildInfoWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ServerBuildInfoOutputV1> getBuildInfoWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Used to determine the precise revision of this Seeq build
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getConfigurationOptions

      public ConfigurationOutputV1 getConfigurationOptions(Integer offset, Integer limit) throws ApiException
      Get the list of configuration options and their details, including the current and default value
      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:
      ConfigurationOutputV1
      Throws:
      ApiException - if fails to make API call
    • getConfigurationOptionsWithHttpInfo

      public ApiClient.ApiResponse<ConfigurationOutputV1> getConfigurationOptionsWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get the list of configuration options and their details, including the current and default value
      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
    • getConfigurationOptionsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ConfigurationOutputV1> getConfigurationOptionsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get the list of configuration options and their details, including the current and default value
      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
    • getInstallerFile

      public byte[] getInstallerFile(String fileName) throws ApiException
      Download installer images
      Parameters:
      fileName - The name of the installation image (required)
      Returns:
      byte[]
      Throws:
      ApiException - if fails to make API call
    • getInstallerFileWithHttpInfo

      public ApiClient.ApiResponse<byte[]> getInstallerFileWithHttpInfo(String fileName) throws ApiException
      Download installer images
      Parameters:
      fileName - The name of the installation image (required)
      Throws:
      ApiException - if fails to make API call
    • getInstallerFileWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<byte[]> getInstallerFileWithHeadersAndHttpInfo(String fileName, Map<String,String> customHeaders) throws ApiException
      Download installer images
      Parameters:
      fileName - The name of the installation image (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getLicense

      public LicenseStatusOutputV1 getLicense() throws ApiException
      Get the current server license, if any
      Returns:
      LicenseStatusOutputV1
      Throws:
      ApiException - if fails to make API call
    • getLicenseWithHttpInfo

      public ApiClient.ApiResponse<LicenseStatusOutputV1> getLicenseWithHttpInfo() throws ApiException
      Get the current server license, if any
      Throws:
      ApiException - if fails to make API call
    • getLicenseWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LicenseStatusOutputV1> getLicenseWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get the current server license, if any
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getOpenPing

      public StatusMessageBase getOpenPing() throws ApiException
      Used to determine server readiness; available without authentication
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • getOpenPingWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> getOpenPingWithHttpInfo() throws ApiException
      Used to determine server readiness; available without authentication
      Throws:
      ApiException - if fails to make API call
    • getOpenPingWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> getOpenPingWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Used to determine server readiness; available without authentication
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getPing

      public StatusMessageBase getPing() throws ApiException
      Used to determine server readiness, but only available with authentication
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • getPingWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> getPingWithHttpInfo() throws ApiException
      Used to determine server readiness, but only available with authentication
      Throws:
      ApiException - if fails to make API call
    • getPingWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> getPingWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Used to determine server readiness, but only available with authentication
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getServerLoad

      public ServerLoadOutputV1 getServerLoad() throws ApiException
      Used to determine the current load the server is experiencing, where a high load indicates a lot of concurrent activity within the server.
      Returns:
      ServerLoadOutputV1
      Throws:
      ApiException - if fails to make API call
    • getServerLoadWithHttpInfo

      public ApiClient.ApiResponse<ServerLoadOutputV1> getServerLoadWithHttpInfo() throws ApiException
      Used to determine the current load the server is experiencing, where a high load indicates a lot of concurrent activity within the server.
      Throws:
      ApiException - if fails to make API call
    • getServerLoadWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ServerLoadOutputV1> getServerLoadWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Used to determine the current load the server is experiencing, where a high load indicates a lot of concurrent activity within the server.
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getServerStatus

      public ServerStatusOutputV1 getServerStatus(Boolean includeInternal) throws ApiException
      Used to determine server readiness, telemetry configuration, and other server variables
      Parameters:
      includeInternal - whether to include internal statuses (optional, default to false)
      Returns:
      ServerStatusOutputV1
      Throws:
      ApiException - if fails to make API call
    • getServerStatusWithHttpInfo

      public ApiClient.ApiResponse<ServerStatusOutputV1> getServerStatusWithHttpInfo(Boolean includeInternal) throws ApiException
      Used to determine server readiness, telemetry configuration, and other server variables
      Parameters:
      includeInternal - whether to include internal statuses (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • getServerStatusWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ServerStatusOutputV1> getServerStatusWithHeadersAndHttpInfo(Boolean includeInternal, Map<String,String> customHeaders) throws ApiException
      Used to determine server readiness, telemetry configuration, and other server variables
      Parameters:
      includeInternal - whether to include internal statuses (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getSupportedUnits

      public SupportedUnitsOutputV1 getSupportedUnits() throws ApiException
      Get list of commonly used and supported units
      Returns:
      SupportedUnitsOutputV1
      Throws:
      ApiException - if fails to make API call
    • getSupportedUnitsWithHttpInfo

      public ApiClient.ApiResponse<SupportedUnitsOutputV1> getSupportedUnitsWithHttpInfo() throws ApiException
      Get list of commonly used and supported units
      Throws:
      ApiException - if fails to make API call
    • getSupportedUnitsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<SupportedUnitsOutputV1> getSupportedUnitsWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get list of commonly used and supported units
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getThreadState

      public void getThreadState(Integer maxFrameCount) throws ApiException
      Get a threaddump of the server as a logfile and send the information to the logs
      Parameters:
      maxFrameCount - Maximum frames to output for each thread. (optional, default to 50)
      Throws:
      ApiException - if fails to make API call
    • getThreadStateWithHttpInfo

      public void getThreadStateWithHttpInfo(Integer maxFrameCount) throws ApiException
      Get a threaddump of the server as a logfile and send the information to the logs
      Parameters:
      maxFrameCount - Maximum frames to output for each thread. (optional, default to 50)
      Throws:
      ApiException - if fails to make API call
    • getThreadStateWithHeadersAndHttpInfo

      public void getThreadStateWithHeadersAndHttpInfo(Integer maxFrameCount, Map<String,String> customHeaders) throws ApiException
      Get a threaddump of the server as a logfile and send the information to the logs
      Parameters:
      maxFrameCount - Maximum frames to output for each thread. (optional, default to 50)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • importLicense

      public LicenseImporterOutputV1 importLicense(byte[] file) throws ApiException
      Import a license file
      Parameters:
      file - (optional)
      Returns:
      LicenseImporterOutputV1
      Throws:
      ApiException - if fails to make API call
    • importLicenseWithHttpInfo

      public ApiClient.ApiResponse<LicenseImporterOutputV1> importLicenseWithHttpInfo(byte[] file) throws ApiException
      Import a license file
      Parameters:
      file - (optional)
      Throws:
      ApiException - if fails to make API call
    • importLicenseWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LicenseImporterOutputV1> importLicenseWithHeadersAndHttpInfo(byte[] file, Map<String,String> customHeaders) throws ApiException
      Import a license file
      Parameters:
      file - (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setAdministratorContactInformation

      public StatusMessageBase setAdministratorContactInformation(AdministratorContactInformationV1 body) throws ApiException
      Set the system administrator's contact information
      Parameters:
      body - The system administrator's contact information (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • setAdministratorContactInformationWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> setAdministratorContactInformationWithHttpInfo(AdministratorContactInformationV1 body) throws ApiException
      Set the system administrator's contact information
      Parameters:
      body - The system administrator's contact information (required)
      Throws:
      ApiException - if fails to make API call
    • setAdministratorContactInformationWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> setAdministratorContactInformationWithHeadersAndHttpInfo(AdministratorContactInformationV1 body, Map<String,String> customHeaders) throws ApiException
      Set the system administrator's contact information
      Parameters:
      body - The system administrator's contact information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setConfigurationOptions

      public ConfigurationOutputV1 setConfigurationOptions(ConfigurationInputV1 body) throws ApiException
      Write one or more configuration options
      Parameters:
      body - Configuration options to write (required)
      Returns:
      ConfigurationOutputV1
      Throws:
      ApiException - if fails to make API call
    • setConfigurationOptionsWithHttpInfo

      public ApiClient.ApiResponse<ConfigurationOutputV1> setConfigurationOptionsWithHttpInfo(ConfigurationInputV1 body) throws ApiException
      Write one or more configuration options
      Parameters:
      body - Configuration options to write (required)
      Throws:
      ApiException - if fails to make API call
    • setConfigurationOptionsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ConfigurationOutputV1> setConfigurationOptionsWithHeadersAndHttpInfo(ConfigurationInputV1 body, Map<String,String> customHeaders) throws ApiException
      Write one or more configuration options
      Parameters:
      body - Configuration options to write (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • uOMs

      Translate an input list to canonical unit of measure strings
      Parameters:
      body - A list of strings representing the UOMs to test against recognized UOMs (required)
      Returns:
      UnitsOfMeasureOutputV1
      Throws:
      ApiException - if fails to make API call
    • uOMsWithHttpInfo

      Translate an input list to canonical unit of measure strings
      Parameters:
      body - A list of strings representing the UOMs to test against recognized UOMs (required)
      Throws:
      ApiException - if fails to make API call
    • uOMsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UnitsOfMeasureOutputV1> uOMsWithHeadersAndHttpInfo(UnitsOfMeasureBatchInputV1 body, Map<String,String> customHeaders) throws ApiException
      Translate an input list to canonical unit of measure strings
      Parameters:
      body - A list of strings representing the UOMs to test against recognized UOMs (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateAddOnTool

      public AddOnToolOutputV1 updateAddOnTool(String id, AddOnToolInputV1 body) throws ApiException
      Update the attributes of an add-on tool
      Parameters:
      id - ID of the add-on tool to update (required)
      body - New add-on tool information (required)
      Returns:
      AddOnToolOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateAddOnToolWithHttpInfo

      public ApiClient.ApiResponse<AddOnToolOutputV1> updateAddOnToolWithHttpInfo(String id, AddOnToolInputV1 body) throws ApiException
      Update the attributes of an add-on tool
      Parameters:
      id - ID of the add-on tool to update (required)
      body - New add-on tool information (required)
      Throws:
      ApiException - if fails to make API call
    • updateAddOnToolWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AddOnToolOutputV1> updateAddOnToolWithHeadersAndHttpInfo(String id, AddOnToolInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update the attributes of an add-on tool
      Parameters:
      id - ID of the add-on tool to update (required)
      body - New add-on tool information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call