Package io.camunda.zeebe.protocol.record.value

Interface TimerRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue, TenantOwned
All Known Implementing Classes:
ImmutableTimerRecordValue
@Immutable public interface TimerRecordValue extends RecordValue, ProcessInstanceRelated, TenantOwned
Represents a timer event or command.

See TimerIntent for intents.

  • Method Details

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Returns:
      the key of the process in which this timer was created

    • getElementInstanceKey

      long getElementInstanceKey()
      Returns:
      the key of the related element instance.

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Specified by:
      getProcessInstanceKey in interface ProcessInstanceRelated
      Returns:
      the key of the related process instance

    • getDueDate

      long getDueDate()
      Returns:
      the due date of the timer as Unix timestamp in millis.

    • getTargetElementId

      String getTargetElementId()
      The handlerFlowNodeID property represent the ID, from the BPMN XML of the process, of the flow node which will handle the timer trigger's event. In normal flow, this is usually the same as the related activity's ID, but when the timer was created due to a boundary event, it will be that event's ID.
      Returns:
      the ID of the flow node which will handle the trigger element

    • getRepetitions

      int getRepetitions()
      Returns:
      the number of times this timer should trigger