Package io.camunda.client.protocol.rest

Class BatchOperationResponse

java.lang.Object

io.camunda.client.protocol.rest.BatchOperationResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class BatchOperationResponse
extends Object

BatchOperationResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTOR_ID
static final String	JSON_PROPERTY_ACTOR_TYPE
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	actorId(String actorId)
BatchOperationResponse	actorType(AuditLogActorTypeEnum actorType)
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	getActorId()	The ID of the actor who performed the operation.
AuditLogActorTypeEnum	getActorType()	The type of the actor who performed the operation.
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.
BatchOperationStateEnum	getState()	Get state
int	hashCode()
BatchOperationResponse	operationsCompletedCount(Integer operationsCompletedCount)
BatchOperationResponse	operationsFailedCount(Integer operationsFailedCount)
BatchOperationResponse	operationsTotalCount(Integer operationsTotalCount)
void	setActorId(String actorId)
void	setActorType(AuditLogActorTypeEnum actorType)
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(BatchOperationStateEnum state)
BatchOperationResponse	startDate(String startDate)
BatchOperationResponse	state(BatchOperationStateEnum state)
String	toString()

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_ACTOR_TYPE

public static final String JSON_PROPERTY_ACTOR_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_ACTOR_ID

public static final String JSON_PROPERTY_ACTOR_ID

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(@Nonnull
 String batchOperationKey)

getBatchOperationKey

@Nonnull
public String getBatchOperationKey()

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

Returns:

batchOperationKey

setBatchOperationKey

public void setBatchOperationKey(@Nonnull
 String batchOperationKey)

state

public BatchOperationResponse state(@Nonnull
 BatchOperationStateEnum state)

getState

@Nonnull
public BatchOperationStateEnum getState()

Get state

Returns:

state

setState

public void setState(@Nonnull
 BatchOperationStateEnum state)

batchOperationType

public BatchOperationResponse batchOperationType(@Nonnull
 BatchOperationTypeEnum batchOperationType)

getBatchOperationType

@Nonnull
public BatchOperationTypeEnum getBatchOperationType()

Get batchOperationType

Returns:

batchOperationType

setBatchOperationType

public void setBatchOperationType(@Nonnull
 BatchOperationTypeEnum batchOperationType)

startDate

public BatchOperationResponse startDate(@Nullable
 String startDate)

getStartDate

@Nullable
public String getStartDate()

The start date of the batch operation. This is `null` if the batch operation has not yet started.

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. This is `null` if the batch operation is still running.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 String endDate)

actorType

public BatchOperationResponse actorType(@Nullable
 AuditLogActorTypeEnum actorType)

getActorType

@Nullable
public AuditLogActorTypeEnum getActorType()

The type of the actor who performed the operation. This is `null` if the batch operation was created before 8.9, or if the actor information is not available.

Returns:

actorType

setActorType

public void setActorType(@Nullable
 AuditLogActorTypeEnum actorType)

actorId

public BatchOperationResponse actorId(@Nullable
 String actorId)

getActorId

@Nullable
public String getActorId()

The ID of the actor who performed the operation. Available for batch operations created since 8.9.

Returns:

actorId

setActorId

public void setActorId(@Nullable
 String actorId)

operationsTotalCount

public BatchOperationResponse operationsTotalCount(@Nonnull
 Integer operationsTotalCount)

getOperationsTotalCount

@Nonnull
public Integer getOperationsTotalCount()

The total number of items contained in this batch operation.

Returns:

operationsTotalCount

setOperationsTotalCount

public void setOperationsTotalCount(@Nonnull
 Integer operationsTotalCount)

operationsFailedCount

public BatchOperationResponse operationsFailedCount(@Nonnull
 Integer operationsFailedCount)

getOperationsFailedCount

@Nonnull
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(@Nonnull
 Integer operationsFailedCount)

operationsCompletedCount

public BatchOperationResponse operationsCompletedCount(@Nonnull
 Integer operationsCompletedCount)

getOperationsCompletedCount

@Nonnull
public Integer getOperationsCompletedCount()

The number of successfully completed tasks.

Returns:

operationsCompletedCount

setOperationsCompletedCount

public void setOperationsCompletedCount(@Nonnull
 Integer operationsCompletedCount)

errors

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

addErrorsItem

public BatchOperationResponse addErrorsItem(BatchOperationError errorsItem)

getErrors

@Nonnull
public List<BatchOperationError> getErrors()

The errors that occurred per partition during the batch operation.

Returns:

errors

setErrors

public void setErrors(@Nonnull
 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