Package io.zeebe.protocol.record.value

Interface IncidentRecordValue

All Superinterfaces:

JsonSerializable, ProcessInstanceRelated, RecordValue

public interface IncidentRecordValue
extends RecordValue, ProcessInstanceRelated

Represents a process incident.

See IncidentIntent for intents.

Method Summary

Modifier and Type	Method	Description
String	getBpmnProcessId()
String	getElementId()
long	getElementInstanceKey()
String	getErrorMessage()
ErrorType	getErrorType()
long	getJobKey()
long	getProcessDefinitionKey()
long	getProcessInstanceKey()
long	getVariableScopeKey()

Methods inherited from interface io.zeebe.protocol.record.JsonSerializable

toJson

Method Detail

getErrorType

ErrorType getErrorType()

Returns:

the type of error this incident is caused by. Can be UNKNOWN if the incident record is part of a IncidentIntent.RESOLVE command.

getErrorMessage

String getErrorMessage()

Returns:

the description of the error this incident is caused by. Can be empty if the incident record is part of a IncidentIntent.RESOLVE command.

getBpmnProcessId

String getBpmnProcessId()

Returns:

the BPMN process id this incident belongs to. Can be empty if the incident record is part of a IncidentIntent.RESOLVE command.

getProcessDefinitionKey

long getProcessDefinitionKey()

Returns:

the key of the process this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

getProcessInstanceKey

long getProcessInstanceKey()

Specified by:

getProcessInstanceKey in interface ProcessInstanceRelated

Returns:

the key of the process instance this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

getElementId

String getElementId()

Returns:

the id of the element this incident belongs to. Can be empty if incident record is part of a IncidentIntent.RESOLVE command.

getElementInstanceKey

long getElementInstanceKey()

Returns:

the key of the element instance this incident belongs to. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.

getJobKey

long getJobKey()

Returns:

the key of the job this incident belongs to. Can be -1 if the incident belongs to no job or the incident record is part of a IncidentIntent.RESOLVE command.

getVariableScopeKey

long getVariableScopeKey()

Returns:

the key of the variable scope on which the variables need to be updated. Can be -1 if the incident record is part of a IncidentIntent.RESOLVE command.