Package io.zeebe.gateway.protocol

Interface GatewayOuterClass.ActivatedJobOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBpmnProcessId()
      the bpmn process ID of the job workflow definition
      com.google.protobuf.ByteString getBpmnProcessIdBytes()
      the bpmn process ID of the job workflow definition
      String getCustomHeaders()
      a set of custom headers defined during modelling; returned as a serialized JSON document
      com.google.protobuf.ByteString getCustomHeadersBytes()
      a set of custom headers defined during modelling; returned as a serialized JSON document
      long getDeadline()
      when the job can be activated again, sent as a UNIX epoch timestamp
      String getElementId()
      the associated task element ID
      com.google.protobuf.ByteString getElementIdBytes()
      the associated task element ID
      long getElementInstanceKey()
      the unique key identifying the associated task, unique within the scope of the workflow instance
      long getKey()
      the key, a unique identifier for the job
      int getRetries()
      the amount of retries left to this job (should always be positive)
      String getType()
      the type of the job (should match what was requested)
      com.google.protobuf.ByteString getTypeBytes()
      the type of the job (should match what was requested)
      String getVariables()
      JSON document, computed at activation time, consisting of all visible variables to the task scope
      com.google.protobuf.ByteString getVariablesBytes()
      JSON document, computed at activation time, consisting of all visible variables to the task scope
      String getWorker()
      the name of the worker which activated this job
      com.google.protobuf.ByteString getWorkerBytes()
      the name of the worker which activated this job
      int getWorkflowDefinitionVersion()
      the version of the job workflow definition
      long getWorkflowInstanceKey()
      the job's workflow instance key
      long getWorkflowKey()
      the key of the job workflow definition

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getKey

        long getKey()
         the key, a unique identifier for the job
        int64 key = 1;
        Returns:
        The key.

      • getType

        String getType()
         the type of the job (should match what was requested)
        string type = 2;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         the type of the job (should match what was requested)
        string type = 2;
        Returns:
        The bytes for type.

      • getWorkflowInstanceKey

        long getWorkflowInstanceKey()
         the job's workflow instance key
        int64 workflowInstanceKey = 3;
        Returns:
        The workflowInstanceKey.

      • getBpmnProcessId

        String getBpmnProcessId()
         the bpmn process ID of the job workflow definition
        string bpmnProcessId = 4;
        Returns:
        The bpmnProcessId.

      • getBpmnProcessIdBytes

        com.google.protobuf.ByteString getBpmnProcessIdBytes()
         the bpmn process ID of the job workflow definition
        string bpmnProcessId = 4;
        Returns:
        The bytes for bpmnProcessId.

      • getWorkflowDefinitionVersion

        int getWorkflowDefinitionVersion()
         the version of the job workflow definition
        int32 workflowDefinitionVersion = 5;
        Returns:
        The workflowDefinitionVersion.

      • getWorkflowKey

        long getWorkflowKey()
         the key of the job workflow definition
        int64 workflowKey = 6;
        Returns:
        The workflowKey.

      • getElementId

        String getElementId()
         the associated task element ID
        string elementId = 7;
        Returns:
        The elementId.

      • getElementIdBytes

        com.google.protobuf.ByteString getElementIdBytes()
         the associated task element ID
        string elementId = 7;
        Returns:
        The bytes for elementId.

      • getElementInstanceKey

        long getElementInstanceKey()
         the unique key identifying the associated task, unique within the scope of the
 workflow instance
        int64 elementInstanceKey = 8;
        Returns:
        The elementInstanceKey.

      • getCustomHeaders

        String getCustomHeaders()
         a set of custom headers defined during modelling; returned as a serialized
 JSON document
        string customHeaders = 9;
        Returns:
        The customHeaders.

      • getCustomHeadersBytes

        com.google.protobuf.ByteString getCustomHeadersBytes()
         a set of custom headers defined during modelling; returned as a serialized
 JSON document
        string customHeaders = 9;
        Returns:
        The bytes for customHeaders.

      • getWorker

        String getWorker()
         the name of the worker which activated this job
        string worker = 10;
        Returns:
        The worker.

      • getWorkerBytes

        com.google.protobuf.ByteString getWorkerBytes()
         the name of the worker which activated this job
        string worker = 10;
        Returns:
        The bytes for worker.

      • getRetries

        int getRetries()
         the amount of retries left to this job (should always be positive)
        int32 retries = 11;
        Returns:
        The retries.

      • getDeadline

        long getDeadline()
         when the job can be activated again, sent as a UNIX epoch timestamp
        int64 deadline = 12;
        Returns:
        The deadline.

      • getVariables

        String getVariables()
         JSON document, computed at activation time, consisting of all visible variables to
 the task scope
        string variables = 13;
        Returns:
        The variables.

      • getVariablesBytes

        com.google.protobuf.ByteString getVariablesBytes()
         JSON document, computed at activation time, consisting of all visible variables to
 the task scope
        string variables = 13;
        Returns:
        The bytes for variables.