com.fortanix.sdkms.v1.api

Class PluginsApi

java.lang.Object

com.fortanix.sdkms.v1.api.PluginsApi

public class PluginsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PluginsApi()
PluginsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Plugin	createPlugin(PluginRequest body) Create a new plugin Create a new plugin with the specified properties.
void	deletePlugin(String pluginId) Delete plugin Remove a plugin from SDKMS.
ApiClient	getApiClient()
Plugin	getPlugin(String pluginId) Get a specific plugin Look up plugin by plugin ID.
List<Plugin>	getPlugins(String groupId) Get all plugins Get details of all plugins the current user has access to.
List<Plugin>	getPlugins(String groupId, String sort, String start, Integer limit, Integer offset) Get all plugins Get details of all plugins the current user has access to.
PluginInvokeResponse	invokePlugin(String pluginId, PluginInvokeRequest body) Invoke a plugin Invokes a plugin execution with the provided request body as input to the plugin.
void	setApiClient(ApiClient apiClient)
PluginInvokeResponse	sysV1PluginsInvokePluginIdGet(String pluginId) Invoke a plugin using GET.
App	updatePlugin(String pluginId, PluginRequest body) Update a plugin Change a plugin's properties, such as name, description, code, or group membership.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginsApi

public PluginsApi()

PluginsApi

public PluginsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPlugin

public Plugin createPlugin(PluginRequest body)
                    throws ApiException

Create a new plugin Create a new plugin with the specified properties.

Parameters:

body - Properties of plugin to create (required)

Returns:

Plugin

Throws:

ApiException - if fails to make API call

deletePlugin

public void deletePlugin(String pluginId)
                  throws ApiException

Delete plugin Remove a plugin from SDKMS.

Parameters:

pluginId - Plugin Identifier (required)

Throws:

ApiException - if fails to make API call

getPlugin

public Plugin getPlugin(String pluginId)
                 throws ApiException

Get a specific plugin Look up plugin by plugin ID.

Parameters:

pluginId - Plugin Identifier (required)

Returns:

Plugin

Throws:

ApiException - if fails to make API call

getPlugins

public List<Plugin> getPlugins(String groupId,
                               String sort,
                               String start,
                               Integer limit,
                               Integer offset)
                        throws ApiException

Get all plugins Get details of all plugins the current user has access to.

Parameters:

groupId - Only retrieve plugins in the specified group. (optional)

sort - This specifies the property (`plugin_id` only, for now) and order (ascending or descending) with which to sort the apps. By default, plugins are sorted by `plugin_id` in ascending order. The syntax is \"<property>:[asc|desc]\" (e.g. \"plugin_id:desc\") or just \"<property>\" (ascending order by default). (optional)

start - If provided, this must be a value of the property specified in `sort`. Returned apps will begin just above or just below this value (for asc/desc order resp.). (optional)

limit - Maximum number of apps to return. If not provided, the limit is 100. (optional)

offset - Number of apps past `start` to skip. (optional)

Returns:

List<Plugin>

Throws:

ApiException - if fails to make API call

invokePlugin

public PluginInvokeResponse invokePlugin(String pluginId,
                                         PluginInvokeRequest body)
                                  throws ApiException

Invoke a plugin Invokes a plugin execution with the provided request body as input to the plugin.

Parameters:

pluginId - Plugin Identifier (required)

body - Object to be passed to plugin as input (required)

Returns:

PluginInvokeResponse

Throws:

ApiException - if fails to make API call

sysV1PluginsInvokePluginIdGet

public PluginInvokeResponse sysV1PluginsInvokePluginIdGet(String pluginId)
                                                   throws ApiException

Invoke a plugin using GET. Invokes a plugin with empty input.

Parameters:

pluginId - Plugin Identifier (required)

Returns:

PluginInvokeResponse

Throws:

ApiException - if fails to make API call

getPlugins

public List<Plugin> getPlugins(String groupId)
                        throws ApiException

Get all plugins Get details of all plugins the current user has access to.

Parameters:

groupId - Only retrieve plugins in the specified group. (optional)

Returns:

List<Plugin>

Throws:

ApiException - if fails to make API call

updatePlugin

public App updatePlugin(String pluginId,
                        PluginRequest body)
                 throws ApiException

Update a plugin Change a plugin's properties, such as name, description, code, or group membership.

Parameters:

pluginId - Plugin Identifier (required)

body - Properties of plugin to create (required)

Returns:

App

Throws:

ApiException - if fails to make API call