public class EventSubscriptionApi extends Object
Constructor and Description |
---|
EventSubscriptionApi() |
EventSubscriptionApi(ApiClient apiClient) |
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)
Get List
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)
Get List (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)
Get List Count
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)
Get List Count (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)
Get List Count
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)
Get List
Queries for event subscriptions that fulfill given parameters.
|
void |
setApiClient(ApiClient apiClient) |
public EventSubscriptionApi()
public EventSubscriptionApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
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
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 progressApiException
- If fail to serialize the request body objectpublic 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
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic 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
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic 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
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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectpublic 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
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 progressApiException
- If fail to serialize the request body objectpublic CountResultDto getEventSubscriptionsCount(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId) throws ApiException
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CountResultDto> getEventSubscriptionsCountWithHttpInfo(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId) throws ApiException
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic 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
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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectCopyright © 2022. All rights reserved.