Package org.camunda.community.rest.client.dto

Class EventSubscriptionQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.EventSubscriptionQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class EventSubscriptionQueryDto extends Object
A event subscription query which retrieves a list of event subscriptions

  • Field Details

  • Constructor Details

    • EventSubscriptionQueryDto

      public EventSubscriptionQueryDto()

  • Method Details

    • eventSubscriptionId

      public EventSubscriptionQueryDto eventSubscriptionId(String eventSubscriptionId)

    • getEventSubscriptionId

      @Nullable public String getEventSubscriptionId()
      The id of the event subscription.
      Returns:
      eventSubscriptionId

    • getEventSubscriptionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getEventSubscriptionId_JsonNullable()

    • setEventSubscriptionId_JsonNullable

      public void setEventSubscriptionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> eventSubscriptionId)

    • setEventSubscriptionId

      public void setEventSubscriptionId(String eventSubscriptionId)

    • eventName

      public EventSubscriptionQueryDto eventName(String eventName)

    • getEventName

      @Nullable public String getEventName()
      The name of the event this subscription belongs to as defined in the process model.
      Returns:
      eventName

    • getEventName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getEventName_JsonNullable()

    • setEventName_JsonNullable

      public void setEventName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> eventName)

    • setEventName

      public void setEventName(String eventName)

    • eventType

      public EventSubscriptionQueryDto eventType(EventSubscriptionQueryDto.EventTypeEnum eventType)

    • getEventType

      @Nullable public EventSubscriptionQueryDto.EventTypeEnum getEventType()
      The type of the event subscription.
      Returns:
      eventType

    • getEventType_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<EventSubscriptionQueryDto.EventTypeEnum> getEventType_JsonNullable()

    • setEventType_JsonNullable

      public void setEventType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<EventSubscriptionQueryDto.EventTypeEnum> eventType)

    • setEventType

      public void setEventType(EventSubscriptionQueryDto.EventTypeEnum eventType)

    • executionId

      public EventSubscriptionQueryDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      The execution that is subscribed on the referenced event.
      Returns:
      executionId

    • getExecutionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExecutionId_JsonNullable()

    • setExecutionId_JsonNullable

      public void setExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> executionId)

    • setExecutionId

      public void setExecutionId(String executionId)

    • processInstanceId

      public EventSubscriptionQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      The process instance this subscription belongs to.
      Returns:
      processInstanceId

    • getProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceId_JsonNullable()

    • setProcessInstanceId_JsonNullable

      public void setProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processInstanceId)

    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)

    • activityId

      public EventSubscriptionQueryDto activityId(String activityId)

    • getActivityId

      @Nullable 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

    • getActivityId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityId_JsonNullable()

    • setActivityId_JsonNullable

      public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityId)

    • setActivityId

      public void setActivityId(String activityId)

    • tenantIdIn

      public EventSubscriptionQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public EventSubscriptionQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable 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

    • getTenantIdIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTenantIdIn_JsonNullable()

    • setTenantIdIn_JsonNullable

      public void setTenantIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tenantIdIn)

    • setTenantIdIn

      public void setTenantIdIn(List<String> tenantIdIn)

    • withoutTenantId

      public EventSubscriptionQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior.
      Returns:
      withoutTenantId

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withoutTenantId)

    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)

    • includeEventSubscriptionsWithoutTenantId

      public EventSubscriptionQueryDto includeEventSubscriptionsWithoutTenantId(Boolean includeEventSubscriptionsWithoutTenantId)

    • getIncludeEventSubscriptionsWithoutTenantId

      @Nullable 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

    • getIncludeEventSubscriptionsWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getIncludeEventSubscriptionsWithoutTenantId_JsonNullable()

    • setIncludeEventSubscriptionsWithoutTenantId_JsonNullable

      public void setIncludeEventSubscriptionsWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeEventSubscriptionsWithoutTenantId)

    • setIncludeEventSubscriptionsWithoutTenantId

      public void setIncludeEventSubscriptionsWithoutTenantId(Boolean includeEventSubscriptionsWithoutTenantId)

    • sorting

      public EventSubscriptionQueryDto sorting(List<EventSubscriptionQueryDtoSortingInner> sorting)

    • addSortingItem

      public EventSubscriptionQueryDto addSortingItem(EventSubscriptionQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<EventSubscriptionQueryDtoSortingInner> getSorting()
      Apply sorting of the result
      Returns:
      sorting

    • getSorting_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<EventSubscriptionQueryDtoSortingInner>> getSorting_JsonNullable()

    • setSorting_JsonNullable

      public void setSorting_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<EventSubscriptionQueryDtoSortingInner>> sorting)

    • setSorting

      public void setSorting(List<EventSubscriptionQueryDtoSortingInner> sorting)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string