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

Class HistoricBatchQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricBatchQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricBatchQueryDto extends Object
Query for the historic batches to set the removal time for.

  • Field Details

  • Constructor Details

    • HistoricBatchQueryDto

      public HistoricBatchQueryDto()

  • Method Details

    • batchId

      public HistoricBatchQueryDto batchId(String batchId)

    • getBatchId

      @Nullable public String getBatchId()
      Filter by batch id.
      Returns:
      batchId

    • getBatchId_JsonNullable

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

    • setBatchId_JsonNullable

      public void setBatchId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> batchId)

    • setBatchId

      public void setBatchId(String batchId)

    • type

      public HistoricBatchQueryDto type(String type)

    • getType

      @Nullable public String getType()
      Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types.
      Returns:
      type

    • getType_JsonNullable

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

    • setType_JsonNullable

      public void setType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> type)

    • setType

      public void setType(String type)

    • completed

      public HistoricBatchQueryDto completed(Boolean completed)

    • getCompleted

      @Nullable public Boolean getCompleted()
      Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned.
      Returns:
      completed

    • getCompleted_JsonNullable

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

    • setCompleted_JsonNullable

      public void setCompleted_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> completed)

    • setCompleted

      public void setCompleted(Boolean completed)

    • tenantIdIn

      public HistoricBatchQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public HistoricBatchQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Filter by a comma-separated list of tenant ids. A batch matches if it has 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 HistoricBatchQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only include batches which belong to no tenant. Value can effectively 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 HistoricBatchQueryDto sorting(List<HistoricBatchQueryDtoSortingInner> sorting)

    • addSortingItem

      public HistoricBatchQueryDto addSortingItem(HistoricBatchQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<HistoricBatchQueryDtoSortingInner> getSorting()
      An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Has no effect for the `/count` endpoint
      Returns:
      sorting

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

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