Package org.openapitools.client.model
Class EventSubscriptionQueryDto
- java.lang.Object
-
- org.openapitools.client.model.EventSubscriptionQueryDto
-
public class EventSubscriptionQueryDto extends Object
A event subscription query which retrieves a list of event subscriptions
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEventSubscriptionQueryDto.EventTypeEnumThe type of the event subscription.
-
Field Summary
Fields Modifier and Type Field Description static StringSERIALIZED_NAME_ACTIVITY_IDstatic StringSERIALIZED_NAME_EVENT_NAMEstatic StringSERIALIZED_NAME_EVENT_SUBSCRIPTION_IDstatic StringSERIALIZED_NAME_EVENT_TYPEstatic StringSERIALIZED_NAME_EXECUTION_IDstatic StringSERIALIZED_NAME_INCLUDE_EVENT_SUBSCRIPTIONS_WITHOUT_TENANT_IDstatic StringSERIALIZED_NAME_PROCESS_INSTANCE_IDstatic StringSERIALIZED_NAME_SORTINGstatic StringSERIALIZED_NAME_TENANT_ID_INstatic StringSERIALIZED_NAME_WITHOUT_TENANT_ID
-
Constructor Summary
Constructors Constructor Description EventSubscriptionQueryDto()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_EVENT_SUBSCRIPTION_ID
public static final String SERIALIZED_NAME_EVENT_SUBSCRIPTION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EVENT_NAME
public static final String SERIALIZED_NAME_EVENT_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EVENT_TYPE
public static final String SERIALIZED_NAME_EVENT_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXECUTION_ID
public static final String SERIALIZED_NAME_EXECUTION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESS_INSTANCE_ID
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACTIVITY_ID
public static final String SERIALIZED_NAME_ACTIVITY_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TENANT_ID_IN
public static final String SERIALIZED_NAME_TENANT_ID_IN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_WITHOUT_TENANT_ID
public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_INCLUDE_EVENT_SUBSCRIPTIONS_WITHOUT_TENANT_ID
public static final String SERIALIZED_NAME_INCLUDE_EVENT_SUBSCRIPTIONS_WITHOUT_TENANT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SORTING
public static final String SERIALIZED_NAME_SORTING
- See Also:
- Constant Field Values
-
-
Method Detail
-
eventSubscriptionId
public EventSubscriptionQueryDto eventSubscriptionId(String eventSubscriptionId)
-
getEventSubscriptionId
public String getEventSubscriptionId()
The id of the event subscription.- Returns:
- eventSubscriptionId
-
setEventSubscriptionId
public void setEventSubscriptionId(String eventSubscriptionId)
-
eventName
public EventSubscriptionQueryDto eventName(String eventName)
-
getEventName
public String getEventName()
The name of the event this subscription belongs to as defined in the process model.- Returns:
- eventName
-
setEventName
public void setEventName(String eventName)
-
eventType
public EventSubscriptionQueryDto eventType(EventSubscriptionQueryDto.EventTypeEnum eventType)
-
getEventType
public EventSubscriptionQueryDto.EventTypeEnum getEventType()
The type of the event subscription.- Returns:
- eventType
-
setEventType
public void setEventType(EventSubscriptionQueryDto.EventTypeEnum eventType)
-
executionId
public EventSubscriptionQueryDto executionId(String executionId)
-
getExecutionId
public String getExecutionId()
The execution that is subscribed on the referenced event.- Returns:
- executionId
-
setExecutionId
public void setExecutionId(String executionId)
-
processInstanceId
public EventSubscriptionQueryDto processInstanceId(String processInstanceId)
-
getProcessInstanceId
public String getProcessInstanceId()
The process instance this subscription belongs to.- Returns:
- processInstanceId
-
setProcessInstanceId
public void setProcessInstanceId(String processInstanceId)
-
activityId
public EventSubscriptionQueryDto activityId(String activityId)
-
getActivityId
public String getActivityId()
The identifier of the activity that this event subscription belongs to. This could for example be the id of a receive task.- Returns:
- activityId
-
setActivityId
public void setActivityId(String activityId)
-
tenantIdIn
public EventSubscriptionQueryDto tenantIdIn(List<String> tenantIdIn)
-
addTenantIdInItem
public EventSubscriptionQueryDto addTenantIdInItem(String tenantIdInItem)
-
getTenantIdIn
public List<String> getTenantIdIn()
Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids.- Returns:
- tenantIdIn
-
withoutTenantId
public EventSubscriptionQueryDto withoutTenantId(Boolean withoutTenantId)
-
getWithoutTenantId
public Boolean getWithoutTenantId()
Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior.- Returns:
- withoutTenantId
-
setWithoutTenantId
public void setWithoutTenantId(Boolean withoutTenantId)
-
includeEventSubscriptionsWithoutTenantId
public EventSubscriptionQueryDto includeEventSubscriptionsWithoutTenantId(Boolean includeEventSubscriptionsWithoutTenantId)
-
getIncludeEventSubscriptionsWithoutTenantId
public Boolean getIncludeEventSubscriptionsWithoutTenantId()
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.- Returns:
- includeEventSubscriptionsWithoutTenantId
-
setIncludeEventSubscriptionsWithoutTenantId
public void setIncludeEventSubscriptionsWithoutTenantId(Boolean includeEventSubscriptionsWithoutTenantId)
-
sorting
public EventSubscriptionQueryDto sorting(List<EventSubscriptionQueryDtoSorting> sorting)
-
addSortingItem
public EventSubscriptionQueryDto addSortingItem(EventSubscriptionQueryDtoSorting sortingItem)
-
getSorting
public List<EventSubscriptionQueryDtoSorting> getSorting()
Apply sorting of the result- Returns:
- sorting
-
setSorting
public void setSorting(List<EventSubscriptionQueryDtoSorting> sorting)
-
-