Package io.zeebe.client.api.response

Interface ActivatedJob

  • All Known Implementing Classes:
    ActivatedJobImpl
    public interface ActivatedJob

    • Method Detail

      • getKey

        long getKey()
        Returns:
        the unique key of the job

      • getType

        String getType()
        Returns:
        the type of the job

      • getWorkflowInstanceKey

        long getWorkflowInstanceKey()
        Returns:
        key of the workflow instance

      • getBpmnProcessId

        String getBpmnProcessId()
        Returns:
        BPMN process id of the workflow

      • getWorkflowDefinitionVersion

        int getWorkflowDefinitionVersion()
        Returns:
        version of the workflow

      • getWorkflowKey

        long getWorkflowKey()
        Returns:
        key of the workflow

      • getElementId

        String getElementId()
        Returns:
        id of the workflow element

      • getElementInstanceKey

        long getElementInstanceKey()
        Returns:
        key of the element instance

      • 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.

      • getVariables

        String getVariables()
        Returns:
        JSON-formatted variables

      • getVariablesAsMap

        Map<String,​Object> getVariablesAsMap()
        Returns:
        de-serialized variables as map

      • getVariablesAsType

        <T> T getVariablesAsType​(Class<T> variableType)
        Returns:
        de-serialized variables as the given type

      • toJson

        String toJson()
        Returns:
        the record encoded as JSON