org.openapitools.client.api

Class EventSubscriptionApi

java.lang.Object

org.openapitools.client.api.EventSubscriptionApi

public class EventSubscriptionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EventSubscriptionApi()
EventSubscriptionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<EventSubscriptionDto>	getEventSubscriptions(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) Queries for event subscriptions that fulfill given parameters.
okhttp3.Call	getEventSubscriptionsAsync(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback<List<EventSubscriptionDto>> _callback) (asynchronously) Queries for event subscriptions that fulfill given parameters.
okhttp3.Call	getEventSubscriptionsCall(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback _callback) Build call for getEventSubscriptions
CountResultDto	getEventSubscriptionsCount(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId) Queries for the number of event subscriptions that fulfill given parameters.
okhttp3.Call	getEventSubscriptionsCountAsync(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, ApiCallback<CountResultDto> _callback) (asynchronously) Queries for the number of event subscriptions that fulfill given parameters.
okhttp3.Call	getEventSubscriptionsCountCall(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, ApiCallback _callback) Build call for getEventSubscriptionsCount
ApiResponse<CountResultDto>	getEventSubscriptionsCountWithHttpInfo(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId) Queries for the number of event subscriptions that fulfill given parameters.
ApiResponse<List<EventSubscriptionDto>>	getEventSubscriptionsWithHttpInfo(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) Queries for event subscriptions that fulfill given parameters.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSubscriptionApi

public EventSubscriptionApi()

EventSubscriptionApi

public EventSubscriptionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getEventSubscriptionsCall

public okhttp3.Call getEventSubscriptionsCall(String eventSubscriptionId,
                                              String eventName,
                                              String eventType,
                                              String executionId,
                                              String processInstanceId,
                                              String activityId,
                                              String tenantIdIn,
                                              Boolean withoutTenantId,
                                              Boolean includeEventSubscriptionsWithoutTenantId,
                                              String sortBy,
                                              String sortOrder,
                                              Integer firstResult,
                                              Integer maxResults,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getEventSubscriptions

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getEventSubscriptions

public List<EventSubscriptionDto> getEventSubscriptions(String eventSubscriptionId,
                                                        String eventName,
                                                        String eventType,
                                                        String executionId,
                                                        String processInstanceId,
                                                        String activityId,
                                                        String tenantIdIn,
                                                        Boolean withoutTenantId,
                                                        Boolean includeEventSubscriptionsWithoutTenantId,
                                                        String sortBy,
                                                        String sortOrder,
                                                        Integer firstResult,
                                                        Integer maxResults)
                                                 throws ApiException

Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query-count/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

Returns:

List<EventSubscriptionDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEventSubscriptionsWithHttpInfo

public ApiResponse<List<EventSubscriptionDto>> getEventSubscriptionsWithHttpInfo(String eventSubscriptionId,
                                                                                 String eventName,
                                                                                 String eventType,
                                                                                 String executionId,
                                                                                 String processInstanceId,
                                                                                 String activityId,
                                                                                 String tenantIdIn,
                                                                                 Boolean withoutTenantId,
                                                                                 Boolean includeEventSubscriptionsWithoutTenantId,
                                                                                 String sortBy,
                                                                                 String sortOrder,
                                                                                 Integer firstResult,
                                                                                 Integer maxResults)
                                                                          throws ApiException

Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query-count/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

Returns:

ApiResponse<List<EventSubscriptionDto>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEventSubscriptionsAsync

public okhttp3.Call getEventSubscriptionsAsync(String eventSubscriptionId,
                                               String eventName,
                                               String eventType,
                                               String executionId,
                                               String processInstanceId,
                                               String activityId,
                                               String tenantIdIn,
                                               Boolean withoutTenantId,
                                               Boolean includeEventSubscriptionsWithoutTenantId,
                                               String sortBy,
                                               String sortOrder,
                                               Integer firstResult,
                                               Integer maxResults,
                                               ApiCallback<List<EventSubscriptionDto>> _callback)
                                        throws ApiException

(asynchronously) Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query-count/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getEventSubscriptionsCountCall

public okhttp3.Call getEventSubscriptionsCountCall(String eventSubscriptionId,
                                                   String eventName,
                                                   String eventType,
                                                   String executionId,
                                                   String processInstanceId,
                                                   String activityId,
                                                   String tenantIdIn,
                                                   Boolean withoutTenantId,
                                                   Boolean includeEventSubscriptionsWithoutTenantId,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for getEventSubscriptionsCount

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getEventSubscriptionsCount

public CountResultDto getEventSubscriptionsCount(String eventSubscriptionId,
                                                 String eventName,
                                                 String eventType,
                                                 String executionId,
                                                 String processInstanceId,
                                                 String activityId,
                                                 String tenantIdIn,
                                                 Boolean withoutTenantId,
                                                 Boolean includeEventSubscriptionsWithoutTenantId)
                                          throws ApiException

Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

Returns:

CountResultDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEventSubscriptionsCountWithHttpInfo

public ApiResponse<CountResultDto> getEventSubscriptionsCountWithHttpInfo(String eventSubscriptionId,
                                                                          String eventName,
                                                                          String eventType,
                                                                          String executionId,
                                                                          String processInstanceId,
                                                                          String activityId,
                                                                          String tenantIdIn,
                                                                          Boolean withoutTenantId,
                                                                          Boolean includeEventSubscriptionsWithoutTenantId)
                                                                   throws ApiException

Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

Returns:

ApiResponse<CountResultDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEventSubscriptionsCountAsync

public okhttp3.Call getEventSubscriptionsCountAsync(String eventSubscriptionId,
                                                    String eventName,
                                                    String eventType,
                                                    String executionId,
                                                    String processInstanceId,
                                                    String activityId,
                                                    String tenantIdIn,
                                                    Boolean withoutTenantId,
                                                    Boolean includeEventSubscriptionsWithoutTenantId,
                                                    ApiCallback<CountResultDto> _callback)
                                             throws ApiException

(asynchronously) Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.14/reference/rest/event-subscription/get-query/) method.

Parameters:

eventSubscriptionId - Only select subscription with the given id. (optional)

eventName - Only select subscriptions for events with the given name. (optional)

eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)

executionId - Only select subscriptions that belong to an execution with the given id. (optional)

processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)

activityId - Only select subscriptions that belong to an activity with the given id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)

withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)

includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object