Package com.exasol.extensionmanager.client.api

Class InstanceApi

java.lang.Object

com.exasol.extensionmanager.client.api.InstanceApi

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-11-09T14:33:10.269580Z[Etc/UTC]")
public class InstanceApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InstanceApi()
InstanceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreateInstanceResponse	createInstance(CreateInstanceRequest body, String dbHost, Integer dbPort, String extensionId, String extensionVersion)	Create an instance of an extension.
void	deleteInstance(String extensionId, String extensionVersion, String instanceId, String dbHost, Integer dbPort)	Delete an instances of an extension.
ApiClient	getApiClient()
ListInstancesResponse	listInstances(String extensionId, String extensionVersion, String dbHost, Integer dbPort)	List all instances of an extension.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceApi

public InstanceApi()

InstanceApi

public InstanceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createInstance

public CreateInstanceResponse createInstance(CreateInstanceRequest body,
                                             String dbHost,
                                             Integer dbPort,
                                             String extensionId,
                                             String extensionVersion)
                                      throws ApiException

Create an instance of an extension. This creates a new instance of an extension, e.g. a virtual schema.

Parameters:

body - (required)

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

extensionId - ID of the installed extension for which to create an instance (required)

extensionVersion - Version of the installed extension for which to create an instance (required)

Returns:

CreateInstanceResponse

Throws:

ApiException - if fails to make API call

deleteInstance

public void deleteInstance(String extensionId,
                           String extensionVersion,
                           String instanceId,
                           String dbHost,
                           Integer dbPort)
                    throws ApiException

Delete an instances of an extension. This deletes a single instances of an extension, e.g. a virtual schema.

Parameters:

extensionId - The ID of the extension for which to delete an instance (required)

extensionVersion - The version of the installed extension for which to delete an instance (required)

instanceId - The ID of the instance to delete (required)

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

Throws:

ApiException - if fails to make API call

listInstances

public ListInstancesResponse listInstances(String extensionId,
                                           String extensionVersion,
                                           String dbHost,
                                           Integer dbPort)
                                    throws ApiException

List all instances of an extension. This lists all instances of an extension, e.g. virtual schema.

Parameters:

extensionId - The ID of the installed extension for which to get the instances (required)

extensionVersion - The version of the installed extension for which to get the instances (required)

dbHost - Exasol database hostname (required)

dbPort - Exasol database port number (required)

Returns:

ListInstancesResponse

Throws:

ApiException - if fails to make API call