Package com.exasol.extensionmanager.client.api

Class ExtensionApi

java.lang.Object

com.exasol.extensionmanager.client.api.ExtensionApi

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-10-20T08:04:15.848592Z[Etc/UTC]")
public class ExtensionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ExtensionApi()
ExtensionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
ExtensionDetailsResponse	getExtensionDetails(String extensionId, String extensionVersion, String dbHost, Integer dbPort)	Get details about an extension version.
void	installExtension(InstallExtensionRequest body, String dbHost, Integer dbPort, String extensionId, String extensionVersion)	Install an extension.
ExtensionsResponse	listAvailableExtensions(String dbHost, Integer dbPort)	List available extensions Get a list of all available extensions, i.e.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionApi

public ExtensionApi()

ExtensionApi

public ExtensionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getExtensionDetails

public ExtensionDetailsResponse getExtensionDetails(String extensionId,
                                                    String extensionVersion,
                                                    String dbHost,
                                                    Integer dbPort)
                                             throws ApiException

Get details about an extension version. This returns details about an extension version, e.g. the parameter definitions required for creating an instance.

Parameters:

extensionId - ID of the extension (required)

extensionVersion - Version of the extension (required)

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

Returns:

ExtensionDetailsResponse

Throws:

ApiException - if fails to make API call

installExtension

public void installExtension(InstallExtensionRequest body,
                             String dbHost,
                             Integer dbPort,
                             String extensionId,
                             String extensionVersion)
                      throws ApiException

Install an extension. This installs an extension in a given version, e.g. by creating Adapter Scripts.

Parameters:

body - (required)

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

extensionId - ID of the extension to install (required)

extensionVersion - Version of the extension to install (required)

Throws:

ApiException - if fails to make API call

listAvailableExtensions

public ExtensionsResponse listAvailableExtensions(String dbHost,
                                                  Integer dbPort)
                                           throws ApiException

List available extensions Get a list of all available extensions, i.e. extensions that can be installed.

Parameters:

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

Returns:

ExtensionsResponse

Throws:

ApiException - if fails to make API call