Package org.bonitasoft.web.client.api

Interface ConnectorInstanceApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.8.0")
public interface ConnectorInstanceApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConnectorInstanceApi.SearchConnectorInstancesQueryParams	A convenience class for generating query parameters for the searchConnectorInstances method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<ConnectorInstance>	searchConnectorInstances(Integer p, Integer c, List<String> f, String o, String s)	Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters.
List<ConnectorInstance>	searchConnectorInstances(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)	Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters.
ApiResponse<List<ConnectorInstance>>	searchConnectorInstancesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds ConnectorInstances Similar to searchConnectorInstances but it also returns the http response headers .
ApiResponse<List<ConnectorInstance>>	searchConnectorInstancesWithHttpInfo(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)	Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters.

Method Details

searchConnectorInstances

List<ConnectorInstance> searchConnectorInstances(Integer p,
 Integer c,
 List<String> f,
 String o,
 String s)

Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters. Retrieve a list of connector instances attached to a process or a flow node.

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

List<ConnectorInstance>

searchConnectorInstancesWithHttpInfo

ApiResponse<List<ConnectorInstance>> searchConnectorInstancesWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String o,
 String s)

Finds ConnectorInstances Similar to searchConnectorInstances but it also returns the http response headers . Finds ConnectorInstances with pagination params and filters. Retrieve a list of connector instances attached to a process or a flow node.

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

searchConnectorInstances

List<ConnectorInstance> searchConnectorInstances(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)

Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters. Retrieve a list of connector instances attached to a process or a flow node. Note, this is equivalent to the other searchConnectorInstances method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the ConnectorInstanceApi.SearchConnectorInstancesQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<ConnectorInstance>

searchConnectorInstancesWithHttpInfo

ApiResponse<List<ConnectorInstance>> searchConnectorInstancesWithHttpInfo(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)

Finds ConnectorInstances Finds ConnectorInstances with pagination params and filters. Retrieve a list of connector instances attached to a process or a flow node. Note, this is equivalent to the other searchConnectorInstances that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<ConnectorInstance>