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

Class HistoricActivityInstanceQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricActivityInstanceQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricActivityInstanceQueryDto extends Object
A historic activity instance query which defines a group of historic activity instances

  • Field Details

  • Constructor Details

    • HistoricActivityInstanceQueryDto

      public HistoricActivityInstanceQueryDto()

  • Method Details

    • activityInstanceId

      public HistoricActivityInstanceQueryDto activityInstanceId(String activityInstanceId)

    • getActivityInstanceId

      @Nullable public String getActivityInstanceId()
      Filter by activity instance id.
      Returns:
      activityInstanceId

    • getActivityInstanceId_JsonNullable

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

    • setActivityInstanceId_JsonNullable

      public void setActivityInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityInstanceId)

    • setActivityInstanceId

      public void setActivityInstanceId(String activityInstanceId)

    • processInstanceId

      public HistoricActivityInstanceQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      Filter by process instance id.
      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)

    • processDefinitionId

      public HistoricActivityInstanceQueryDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Filter by process definition id.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

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

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • executionId

      public HistoricActivityInstanceQueryDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      Filter by the id of the execution that executed the activity instance.
      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)

    • activityId

      public HistoricActivityInstanceQueryDto activityId(String activityId)

    • getActivityId

      @Nullable public String getActivityId()
      Filter by the activity id (according to BPMN 2.0 XML).
      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)

    • activityName

      public HistoricActivityInstanceQueryDto activityName(String activityName)

    • getActivityName

      @Nullable public String getActivityName()
      Filter by the activity name (according to BPMN 2.0 XML).
      Returns:
      activityName

    • getActivityName_JsonNullable

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

    • setActivityName_JsonNullable

      public void setActivityName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityName)

    • setActivityName

      public void setActivityName(String activityName)

    • activityType

      public HistoricActivityInstanceQueryDto activityType(String activityType)

    • getActivityType

      @Nullable public String getActivityType()
      Filter by activity type.
      Returns:
      activityType

    • getActivityType_JsonNullable

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

    • setActivityType_JsonNullable

      public void setActivityType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityType)

    • setActivityType

      public void setActivityType(String activityType)

    • taskAssignee

      public HistoricActivityInstanceQueryDto taskAssignee(String taskAssignee)

    • getTaskAssignee

      @Nullable public String getTaskAssignee()
      Only include activity instances that are user tasks and assigned to a given user.
      Returns:
      taskAssignee

    • getTaskAssignee_JsonNullable

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

    • setTaskAssignee_JsonNullable

      public void setTaskAssignee_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> taskAssignee)

    • setTaskAssignee

      public void setTaskAssignee(String taskAssignee)

    • finished

      public HistoricActivityInstanceQueryDto finished(Boolean finished)

    • getFinished

      @Nullable public Boolean getFinished()
      Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.
      Returns:
      finished

    • getFinished_JsonNullable

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

    • setFinished_JsonNullable

      public void setFinished_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> finished)

    • setFinished

      public void setFinished(Boolean finished)

    • unfinished

      public HistoricActivityInstanceQueryDto unfinished(Boolean unfinished)

    • getUnfinished

      @Nullable public Boolean getUnfinished()
      Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.
      Returns:
      unfinished

    • getUnfinished_JsonNullable

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

    • setUnfinished_JsonNullable

      public void setUnfinished_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> unfinished)

    • setUnfinished

      public void setUnfinished(Boolean unfinished)

    • canceled

      public HistoricActivityInstanceQueryDto canceled(Boolean canceled)

    • getCanceled

      @Nullable public Boolean getCanceled()
      Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set.
      Returns:
      canceled

    • getCanceled_JsonNullable

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

    • setCanceled_JsonNullable

      public void setCanceled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> canceled)

    • setCanceled

      public void setCanceled(Boolean canceled)

    • completeScope

      public HistoricActivityInstanceQueryDto completeScope(Boolean completeScope)

    • getCompleteScope

      @Nullable public Boolean getCompleteScope()
      Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set.
      Returns:
      completeScope

    • getCompleteScope_JsonNullable

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

    • setCompleteScope_JsonNullable

      public void setCompleteScope_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> completeScope)

    • setCompleteScope

      public void setCompleteScope(Boolean completeScope)

    • startedBefore

      public HistoricActivityInstanceQueryDto startedBefore(OffsetDateTime startedBefore)

    • getStartedBefore

      @Nullable public OffsetDateTime getStartedBefore()
      Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      Returns:
      startedBefore

    • getStartedBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getStartedBefore_JsonNullable()

    • setStartedBefore_JsonNullable

      public void setStartedBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> startedBefore)

    • setStartedBefore

      public void setStartedBefore(OffsetDateTime startedBefore)

    • startedAfter

      public HistoricActivityInstanceQueryDto startedAfter(OffsetDateTime startedAfter)

    • getStartedAfter

      @Nullable public OffsetDateTime getStartedAfter()
      Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      Returns:
      startedAfter

    • getStartedAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getStartedAfter_JsonNullable()

    • setStartedAfter_JsonNullable

      public void setStartedAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> startedAfter)

    • setStartedAfter

      public void setStartedAfter(OffsetDateTime startedAfter)

    • finishedBefore

      public HistoricActivityInstanceQueryDto finishedBefore(OffsetDateTime finishedBefore)

    • getFinishedBefore

      @Nullable public OffsetDateTime getFinishedBefore()
      Restrict to instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      Returns:
      finishedBefore

    • getFinishedBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getFinishedBefore_JsonNullable()

    • setFinishedBefore_JsonNullable

      public void setFinishedBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> finishedBefore)

    • setFinishedBefore

      public void setFinishedBefore(OffsetDateTime finishedBefore)

    • finishedAfter

      public HistoricActivityInstanceQueryDto finishedAfter(OffsetDateTime finishedAfter)

    • getFinishedAfter

      @Nullable public OffsetDateTime getFinishedAfter()
      Restrict to instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      Returns:
      finishedAfter

    • getFinishedAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getFinishedAfter_JsonNullable()

    • setFinishedAfter_JsonNullable

      public void setFinishedAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> finishedAfter)

    • setFinishedAfter

      public void setFinishedAfter(OffsetDateTime finishedAfter)

    • tenantIdIn

      public HistoricActivityInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public HistoricActivityInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Must be a JSON array of Strings. An activity instance must have 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 HistoricActivityInstanceQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only include historic activity instances that belong to no tenant. 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)

    • sorting

      public HistoricActivityInstanceQueryDto sorting(List<HistoricActivityInstanceQueryDtoSortingInner> sorting)

    • addSortingItem

      public HistoricActivityInstanceQueryDto addSortingItem(HistoricActivityInstanceQueryDtoSortingInner sortingItem)

    • getSorting

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

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

      public void setSorting(List<HistoricActivityInstanceQueryDtoSortingInner> 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