java.lang.Object
- org.openapitools.client.model.HistoricBatchQueryDto

```
public class HistoricBatchQueryDto
extends Object
```
Query for the historic batches to set the removal time for.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_BATCH_ID`
`static String`	`SERIALIZED_NAME_COMPLETED`
`static String`	`SERIALIZED_NAME_SORTING`
`static String`	`SERIALIZED_NAME_TENANT_ID_IN`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_WITHOUT_TENANT_ID`

Constructor Summary

Constructors
Constructor Description

HistoricBatchQueryDto()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HistoricBatchQueryDto`	`addSortingItem(HistoricBatchQueryDtoSorting sortingItem)`
`HistoricBatchQueryDto`	`addTenantIdInItem(String tenantIdInItem)`
`HistoricBatchQueryDto`	`batchId(String batchId)`
`HistoricBatchQueryDto`	`completed(Boolean completed)`
`boolean`	`equals(Object o)`
`String`	`getBatchId()`	Filter by batch id.
`Boolean`	`getCompleted()`	Filter completed or not completed batches.
`List<HistoricBatchQueryDtoSorting>`	`getSorting()`	An array of criteria to sort the result by.
`List<String>`	`getTenantIdIn()`	Filter by a comma-separated list of tenant ids.
`String`	`getType()`	Filter by batch type.
`Boolean`	`getWithoutTenantId()`	Only include batches which belong to no tenant.
`int`	`hashCode()`
`void`	`setBatchId(String batchId)`
`void`	`setCompleted(Boolean completed)`
`void`	`setSorting(List<HistoricBatchQueryDtoSorting> sorting)`
`void`	`setTenantIdIn(List<String> tenantIdIn)`
`void`	`setType(String type)`
`void`	`setWithoutTenantId(Boolean withoutTenantId)`
`HistoricBatchQueryDto`	`sorting(List<HistoricBatchQueryDtoSorting> sorting)`
`HistoricBatchQueryDto`	`tenantIdIn(List<String> tenantIdIn)`
`String`	`toString()`
`HistoricBatchQueryDto`	`type(String type)`
`HistoricBatchQueryDto`	`withoutTenantId(Boolean withoutTenantId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_BATCH_ID
```
public static final String SERIALIZED_NAME_BATCH_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COMPLETED
```
public static final String SERIALIZED_NAME_COMPLETED
```
    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_SORTING
```
public static final String SERIALIZED_NAME_SORTING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HistoricBatchQueryDto
```
public HistoricBatchQueryDto()
```
- Method Detail
  - batchId
```
public HistoricBatchQueryDto batchId(String batchId)
```
  - getBatchId
```
public String getBatchId()
```
    Filter by batch id.
    
    Returns:
    
    batchId
  - setBatchId
```
public void setBatchId(String batchId)
```
  - type
```
public HistoricBatchQueryDto type(String type)
```
  - getType
```
public String getType()
```
    Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types.
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - completed
```
public HistoricBatchQueryDto completed(Boolean completed)
```
  - getCompleted
```
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
  - setCompleted
```
public void setCompleted(Boolean completed)
```
  - tenantIdIn
```
public HistoricBatchQueryDto tenantIdIn(List<String> tenantIdIn)
```
  - addTenantIdInItem
```
public HistoricBatchQueryDto addTenantIdInItem(String tenantIdInItem)
```
  - getTenantIdIn
```
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
  - setTenantIdIn
```
public void setTenantIdIn(List<String> tenantIdIn)
```
  - withoutTenantId
```
public HistoricBatchQueryDto withoutTenantId(Boolean withoutTenantId)
```
  - getWithoutTenantId
```
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
  - setWithoutTenantId
```
public void setWithoutTenantId(Boolean withoutTenantId)
```
  - sorting
```
public HistoricBatchQueryDto sorting(List<HistoricBatchQueryDtoSorting> sorting)
```
  - addSortingItem
```
public HistoricBatchQueryDto addSortingItem(HistoricBatchQueryDtoSorting sortingItem)
```
  - getSorting
```
public List<HistoricBatchQueryDtoSorting> 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
  - setSorting
```
public void setSorting(List<HistoricBatchQueryDtoSorting> 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

Class HistoricBatchQueryDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_BATCH_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_COMPLETED

SERIALIZED_NAME_TENANT_ID_IN

SERIALIZED_NAME_WITHOUT_TENANT_ID

SERIALIZED_NAME_SORTING

Constructor Detail

HistoricBatchQueryDto

Method Detail

batchId

getBatchId

setBatchId

type

getType

setType

completed

getCompleted

setCompleted

tenantIdIn

addTenantIdInItem

getTenantIdIn

setTenantIdIn

withoutTenantId

getWithoutTenantId

setWithoutTenantId

sorting

addSortingItem

getSorting

setSorting

equals

hashCode

toString