Package io.camunda.client.protocol.rest

Class BatchOperationItemFilter

java.lang.Object

io.camunda.client.protocol.rest.BatchOperationItemFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-04T12:01:10.435788262Z[GMT]",
           comments="Generator version: 7.12.0")
public class BatchOperationItemFilter
extends Object

Batch operation item filter request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BatchOperationItemFilter.StateEnum	The state of the batch operation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BATCH_OPERATION_ID
static final String	JSON_PROPERTY_ITEM_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_STATE

Constructor Summary

Constructors

Constructor	Description
BatchOperationItemFilter()

Method Summary

Modifier and Type	Method	Description
BatchOperationItemFilter	batchOperationId(String batchOperationId)
boolean	equals(Object o)
String	getBatchOperationId()	The key (or operate legacy ID) of the batch operation.
String	getItemKey()	The key of the item, e.g. a process instance key.
String	getProcessInstanceKey()	The process instance key of the processed item.
BatchOperationItemFilter.StateEnum	getState()	The state of the batch operation.
int	hashCode()
BatchOperationItemFilter	itemKey(String itemKey)
BatchOperationItemFilter	processInstanceKey(String processInstanceKey)
void	setBatchOperationId(String batchOperationId)
void	setItemKey(String itemKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setState(BatchOperationItemFilter.StateEnum state)
BatchOperationItemFilter	state(BatchOperationItemFilter.StateEnum state)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_BATCH_OPERATION_ID

public static final String JSON_PROPERTY_BATCH_OPERATION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ITEM_KEY

public static final String JSON_PROPERTY_ITEM_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

Constructor Details

BatchOperationItemFilter

public BatchOperationItemFilter()

Method Details

batchOperationId

public BatchOperationItemFilter batchOperationId(@Nullable
 String batchOperationId)

getBatchOperationId

@Nullable
public String getBatchOperationId()

The key (or operate legacy ID) of the batch operation.

Returns:

batchOperationId

setBatchOperationId

public void setBatchOperationId(@Nullable
 String batchOperationId)

itemKey

public BatchOperationItemFilter itemKey(@Nullable
 String itemKey)

getItemKey

@Nullable
public String getItemKey()

The key of the item, e.g. a process instance key.

Returns:

itemKey

setItemKey

public void setItemKey(@Nullable
 String itemKey)

processInstanceKey

public BatchOperationItemFilter processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The process instance key of the processed item.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

state

public BatchOperationItemFilter state(@Nullable
 BatchOperationItemFilter.StateEnum state)

getState

@Nullable
public BatchOperationItemFilter.StateEnum getState()

The state of the batch operation.

Returns:

state

setState

public void setState(@Nullable
 BatchOperationItemFilter.StateEnum state)

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