Package io.camunda.client.protocol.rest

Class BatchOperationItemResponse

java.lang.Object

io.camunda.client.protocol.rest.BatchOperationItemResponse

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

BatchOperationItemResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BatchOperationItemResponse.StateEnum	State of the item.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
BatchOperationItemResponse()

Method Summary

Modifier and Type	Method	Description
BatchOperationItemResponse	batchOperationId(String batchOperationId)
boolean	equals(Object o)
BatchOperationItemResponse	errorMessage(String errorMessage)
String	getBatchOperationId()	The key (or operate legacy ID) of the batch operation.
String	getErrorMessage()	the error message from the engine in case of a failed operation.
String	getItemKey()	Key of the item, e.g. a process instance key.
String	getProcessedDate()	the date this item was processed.
String	getProcessInstanceKey()	the process instance key of the processed item.
BatchOperationItemResponse.StateEnum	getState()	State of the item.
int	hashCode()
BatchOperationItemResponse	itemKey(String itemKey)
BatchOperationItemResponse	processedDate(String processedDate)
BatchOperationItemResponse	processInstanceKey(String processInstanceKey)
void	setBatchOperationId(String batchOperationId)
void	setErrorMessage(String errorMessage)
void	setItemKey(String itemKey)
void	setProcessedDate(String processedDate)
void	setProcessInstanceKey(String processInstanceKey)
void	setState(BatchOperationItemResponse.StateEnum state)
BatchOperationItemResponse	state(BatchOperationItemResponse.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

JSON_PROPERTY_PROCESSED_DATE

public static final String JSON_PROPERTY_PROCESSED_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR_MESSAGE

public static final String JSON_PROPERTY_ERROR_MESSAGE

See Also:

• Constant Field Values

Constructor Details

BatchOperationItemResponse

public BatchOperationItemResponse()

Method Details

batchOperationId

public BatchOperationItemResponse 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 BatchOperationItemResponse itemKey(@Nullable
 String itemKey)

getItemKey

@Nullable
public String getItemKey()

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

Returns:

itemKey

setItemKey

public void setItemKey(@Nullable
 String itemKey)

processInstanceKey

public BatchOperationItemResponse 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 BatchOperationItemResponse state(@Nullable
 BatchOperationItemResponse.StateEnum state)

getState

@Nullable
public BatchOperationItemResponse.StateEnum getState()

State of the item.

Returns:

state

setState

public void setState(@Nullable
 BatchOperationItemResponse.StateEnum state)

processedDate

public BatchOperationItemResponse processedDate(@Nullable
 String processedDate)

getProcessedDate

@Nullable
public String getProcessedDate()

the date this item was processed. This can be either completed, canceled or failed.

Returns:

processedDate

setProcessedDate

public void setProcessedDate(@Nullable
 String processedDate)

errorMessage

public BatchOperationItemResponse errorMessage(@Nullable
 String errorMessage)

getErrorMessage

@Nullable
public String getErrorMessage()

the error message from the engine in case of a failed operation.

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(@Nullable
 String errorMessage)

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