Package io.zeebe.protocol.record.value
Interface JobRecordValue
-
- All Superinterfaces:
JsonSerializable,ProcessInstanceRelated,RecordValue,RecordValueWithVariables
public interface JobRecordValue extends RecordValueWithVariables, ProcessInstanceRelated
Represents a job related event or command.See
JobIntentfor intents.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBpmnProcessId()Map<String,String>getCustomHeaders()longgetDeadline()StringgetElementId()longgetElementInstanceKey()StringgetErrorCode()StringgetErrorMessage()longgetProcessDefinitionKey()intgetProcessDefinitionVersion()intgetRetries()StringgetType()StringgetWorker()-
Methods inherited from interface io.zeebe.protocol.record.JsonSerializable
toJson
-
Methods inherited from interface io.zeebe.protocol.record.value.ProcessInstanceRelated
getProcessInstanceKey
-
Methods inherited from interface io.zeebe.protocol.record.RecordValueWithVariables
getVariables
-
-
-
-
Method Detail
-
getType
String getType()
- Returns:
- the type of the job
-
getCustomHeaders
Map<String,String> getCustomHeaders()
- Returns:
- user-defined headers associated with this job
-
getWorker
String getWorker()
- Returns:
- the assigned worker to complete the job
-
getRetries
int getRetries()
- Returns:
- remaining retries
-
getDeadline
long getDeadline()
- Returns:
- the unix timestamp until when the job is exclusively assigned to this worker (time unit is milliseconds since unix epoch). If the deadline is exceeded, it can happen that the job is handed to another worker and the work is performed twice. If this property is not set it will return '-1'.
-
getErrorMessage
String getErrorMessage()
- Returns:
- the message that contains additional context of the failure/error. It is set by the job worker then the processing fails because of a technical failure or a non-technical error.
-
getErrorCode
String getErrorCode()
- Returns:
- the error code to identify the business error. It is set by the job worker then the processing fails because of a non-technical error that should be handled by the process.
-
getElementId
String getElementId()
- Returns:
- the element id of the corresponding service task
-
getElementInstanceKey
long getElementInstanceKey()
- Returns:
- the element instance key of the corresponding service task
-
getBpmnProcessId
String getBpmnProcessId()
- Returns:
- the bpmn process id of the corresponding process definition
-
getProcessDefinitionVersion
int getProcessDefinitionVersion()
- Returns:
- the version of the corresponding process definition
-
getProcessDefinitionKey
long getProcessDefinitionKey()
- Returns:
- the process key of the corresponding process definition
-
-