Package io.camunda.client.protocol.rest

Class BatchOperationResponse

java.lang.Object

io.camunda.client.protocol.rest.BatchOperationResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class BatchOperationResponse
extends Object

BatchOperationResponse

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BATCH_OPERATION_KEY
static final String	JSON_PROPERTY_BATCH_OPERATION_TYPE
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_ERRORS
static final String	JSON_PROPERTY_OPERATIONS_COMPLETED_COUNT
static final String	JSON_PROPERTY_OPERATIONS_FAILED_COUNT
static final String	JSON_PROPERTY_OPERATIONS_TOTAL_COUNT
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_STATE

Constructor Summary

Constructors

Constructor	Description
BatchOperationResponse()

Method Summary

Modifier and Type	Method	Description
BatchOperationResponse	addErrorsItem(BatchOperationError errorsItem)
BatchOperationResponse	batchOperationKey(String batchOperationKey)
BatchOperationResponse	batchOperationType(BatchOperationTypeEnum batchOperationType)
BatchOperationResponse	endDate(String endDate)
boolean	equals(Object o)
BatchOperationResponse	errors(List<BatchOperationError> errors)
String	getBatchOperationKey()	Key or (Operate Legacy ID = UUID) of the batch operation.
BatchOperationTypeEnum	getBatchOperationType()	Get batchOperationType
String	getEndDate()	The end date of the batch operation.
List<BatchOperationError>	getErrors()	The errors that occurred per partition during the batch operation.
Integer	getOperationsCompletedCount()	The number of successfully completed tasks.
Integer	getOperationsFailedCount()	The number of items which failed during execution of the batch operation.
Integer	getOperationsTotalCount()	The total number of items contained in this batch operation.
String	getStartDate()	The start date of the batch operation.
BatchOperationResponse.StateEnum	getState()	The state of the batch operation.
int	hashCode()
BatchOperationResponse	operationsCompletedCount(Integer operationsCompletedCount)
BatchOperationResponse	operationsFailedCount(Integer operationsFailedCount)
BatchOperationResponse	operationsTotalCount(Integer operationsTotalCount)
void	setBatchOperationKey(String batchOperationKey)
void	setBatchOperationType(BatchOperationTypeEnum batchOperationType)
void	setEndDate(String endDate)
void	setErrors(List<BatchOperationError> errors)
void	setOperationsCompletedCount(Integer operationsCompletedCount)
void	setOperationsFailedCount(Integer operationsFailedCount)
void	setOperationsTotalCount(Integer operationsTotalCount)
void	setStartDate(String startDate)
void	setState(BatchOperationResponse.StateEnum state)
BatchOperationResponse	startDate(String startDate)
BatchOperationResponse	state(BatchOperationResponse.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_KEY

public static final String JSON_PROPERTY_BATCH_OPERATION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_BATCH_OPERATION_TYPE

public static final String JSON_PROPERTY_BATCH_OPERATION_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_START_DATE

public static final String JSON_PROPERTY_START_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_END_DATE

public static final String JSON_PROPERTY_END_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATIONS_TOTAL_COUNT

public static final String JSON_PROPERTY_OPERATIONS_TOTAL_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATIONS_FAILED_COUNT

public static final String JSON_PROPERTY_OPERATIONS_FAILED_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATIONS_COMPLETED_COUNT

public static final String JSON_PROPERTY_OPERATIONS_COMPLETED_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_ERRORS

public static final String JSON_PROPERTY_ERRORS

See Also:

• Constant Field Values

Constructor Details

BatchOperationResponse

public BatchOperationResponse()

Method Details

batchOperationKey

public BatchOperationResponse batchOperationKey(@Nullable
 String batchOperationKey)

getBatchOperationKey

@Nullable
public String getBatchOperationKey()

Key or (Operate Legacy ID = UUID) of the batch operation.

Returns:

batchOperationKey

setBatchOperationKey

public void setBatchOperationKey(@Nullable
 String batchOperationKey)

state

public BatchOperationResponse state(@Nullable
 BatchOperationResponse.StateEnum state)

getState

@Nullable
public BatchOperationResponse.StateEnum getState()

The state of the batch operation.

Returns:

state

setState

public void setState(@Nullable
 BatchOperationResponse.StateEnum state)

batchOperationType

public BatchOperationResponse batchOperationType(@Nullable
 BatchOperationTypeEnum batchOperationType)

getBatchOperationType

@Nullable
public BatchOperationTypeEnum getBatchOperationType()

Get batchOperationType

Returns:

batchOperationType

setBatchOperationType

public void setBatchOperationType(@Nullable
 BatchOperationTypeEnum batchOperationType)

startDate

public BatchOperationResponse startDate(@Nullable
 String startDate)

getStartDate

@Nullable
public String getStartDate()

The start date of the batch operation.

Returns:

startDate

setStartDate

public void setStartDate(@Nullable
 String startDate)

endDate

public BatchOperationResponse endDate(@Nullable
 String endDate)

getEndDate

@Nullable
public String getEndDate()

The end date of the batch operation.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 String endDate)

operationsTotalCount

public BatchOperationResponse operationsTotalCount(@Nullable
 Integer operationsTotalCount)

getOperationsTotalCount

@Nullable
public Integer getOperationsTotalCount()

The total number of items contained in this batch operation.

Returns:

operationsTotalCount

setOperationsTotalCount

public void setOperationsTotalCount(@Nullable
 Integer operationsTotalCount)

operationsFailedCount

public BatchOperationResponse operationsFailedCount(@Nullable
 Integer operationsFailedCount)

getOperationsFailedCount

@Nullable
public Integer getOperationsFailedCount()

The number of items which failed during execution of the batch operation. (e.g. because they are rejected by the Zeebe engine).

Returns:

operationsFailedCount

setOperationsFailedCount

public void setOperationsFailedCount(@Nullable
 Integer operationsFailedCount)

operationsCompletedCount

public BatchOperationResponse operationsCompletedCount(@Nullable
 Integer operationsCompletedCount)

getOperationsCompletedCount

@Nullable
public Integer getOperationsCompletedCount()

The number of successfully completed tasks.

Returns:

operationsCompletedCount

setOperationsCompletedCount

public void setOperationsCompletedCount(@Nullable
 Integer operationsCompletedCount)

errors

public BatchOperationResponse errors(@Nullable
 List<BatchOperationError> errors)

addErrorsItem

public BatchOperationResponse addErrorsItem(BatchOperationError errorsItem)

getErrors

@Nullable
public List<BatchOperationError> getErrors()

The errors that occurred per partition during the batch operation.

Returns:

errors

setErrors

public void setErrors(@Nullable
 List<BatchOperationError> errors)

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