Package io.camunda.client.protocol.rest

Class BatchOperationItemResponse

java.lang.Object

io.camunda.client.protocol.rest.BatchOperationItemResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.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_KEY
static final String	JSON_PROPERTY_ERROR_MESSAGE
static final String	JSON_PROPERTY_ITEM_KEY
static final String	JSON_PROPERTY_OPERATION_TYPE
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_PROCESSED_DATE
static final String	JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_STATE

Constructor Summary

Constructors

Constructor	Description
BatchOperationItemResponse()

Method Summary

Modifier and Type	Method	Description
BatchOperationItemResponse	batchOperationKey(String batchOperationKey)
boolean	equals(Object o)
BatchOperationItemResponse	errorMessage(String errorMessage)
String	getBatchOperationKey()	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.
BatchOperationTypeEnum	getOperationType()	Get operationType
String	getProcessedDate()	The date this item was processed.
String	getProcessInstanceKey()	The process instance key of the processed item.
String	getRootProcessInstanceKey()	The key of the root process instance.
BatchOperationItemResponse.StateEnum	getState()	State of the item.
int	hashCode()
BatchOperationItemResponse	itemKey(String itemKey)
BatchOperationItemResponse	operationType(BatchOperationTypeEnum operationType)
BatchOperationItemResponse	processedDate(String processedDate)
BatchOperationItemResponse	processInstanceKey(String processInstanceKey)
BatchOperationItemResponse	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setBatchOperationKey(String batchOperationKey)
void	setErrorMessage(String errorMessage)
void	setItemKey(String itemKey)
void	setOperationType(BatchOperationTypeEnum operationType)
void	setProcessedDate(String processedDate)
void	setProcessInstanceKey(String processInstanceKey)
void	setRootProcessInstanceKey(String rootProcessInstanceKey)
void	setState(BatchOperationItemResponse.StateEnum state)
BatchOperationItemResponse	state(BatchOperationItemResponse.StateEnum state)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_OPERATION_TYPE

public static final String JSON_PROPERTY_OPERATION_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_BATCH_OPERATION_KEY

public static final String JSON_PROPERTY_BATCH_OPERATION_KEY

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_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_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

operationType

public BatchOperationItemResponse operationType(@Nonnull
 BatchOperationTypeEnum operationType)

getOperationType

@Nonnull
public BatchOperationTypeEnum getOperationType()

Get operationType

Returns:

operationType

setOperationType

public void setOperationType(@Nonnull
 BatchOperationTypeEnum operationType)

batchOperationKey

public BatchOperationItemResponse batchOperationKey(@Nonnull
 String batchOperationKey)

getBatchOperationKey

@Nonnull
public String getBatchOperationKey()

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

Returns:

batchOperationKey

setBatchOperationKey

public void setBatchOperationKey(@Nonnull
 String batchOperationKey)

itemKey

public BatchOperationItemResponse itemKey(@Nonnull
 String itemKey)

getItemKey

@Nonnull
public String getItemKey()

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

Returns:

itemKey

setItemKey

public void setItemKey(@Nonnull
 String itemKey)

processInstanceKey

public BatchOperationItemResponse processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The process instance key of the processed item. Null for batch-op types whose targets are not process instances (e.g. DELETE_DECISION_INSTANCE, DELETE_DECISION_DEFINITION, DELETE_PROCESS_DEFINITION).

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

rootProcessInstanceKey

public BatchOperationItemResponse rootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

getRootProcessInstanceKey

@Nullable
public String getRootProcessInstanceKey()

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

Returns:

rootProcessInstanceKey

setRootProcessInstanceKey

public void setRootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

state

public BatchOperationItemResponse state(@Nonnull
 BatchOperationItemResponse.StateEnum state)

getState

@Nonnull
public BatchOperationItemResponse.StateEnum getState()

State of the item.

Returns:

state

setState

public void setState(@Nonnull
 BatchOperationItemResponse.StateEnum state)

processedDate

public BatchOperationItemResponse processedDate(@Nullable
 String processedDate)

getProcessedDate

@Nullable
public String getProcessedDate()

The date this item was processed. This is `null` if the item has not yet been processed.

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