Package io.camunda.zeebe.gateway.protocol

Interface GatewayOuterClass.ActivatedJobOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GatewayOuterClass.ActivatedJob, GatewayOuterClass.ActivatedJob.Builder
Enclosing class:
GatewayOuterClass
public static interface GatewayOuterClass.ActivatedJobOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBpmnProcessId()
    the bpmn process ID of the job process definition
    com.google.protobuf.ByteString
    getBpmnProcessIdBytes()
    the bpmn process ID of the job process 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 process instance
    long
    getKey()
    the key, a unique identifier for the job
    long
    getProcessDefinitionKey()
    the key of the job process definition
    int
    getProcessDefinitionVersion()
    the version of the job process definition
    long
    getProcessInstanceKey()
    the job's process instance key
    int
    getRetries()
    the amount of retries left to this job (should always be positive)
    String
    getTenantId()
    // the id of the tenant that owns the job
    com.google.protobuf.ByteString
    getTenantIdBytes()
    // the id of the tenant that owns the job
    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

    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 Details

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

    • getProcessInstanceKey

      long getProcessInstanceKey()
       the job's process instance key
      int64 processInstanceKey = 3;
      Returns:
      The processInstanceKey.

    • getBpmnProcessId

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

    • getBpmnProcessIdBytes

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

    • getProcessDefinitionVersion

      int getProcessDefinitionVersion()
       the version of the job process definition
      int32 processDefinitionVersion = 5;
      Returns:
      The processDefinitionVersion.

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
       the key of the job process definition
      int64 processDefinitionKey = 6;
      Returns:
      The processDefinitionKey.

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

    • getTenantId

      String getTenantId()
       // the id of the tenant that owns the job
      string tenantId = 14;
      Returns:
      The tenantId.

    • getTenantIdBytes

      com.google.protobuf.ByteString getTenantIdBytes()
       // the id of the tenant that owns the job
      string tenantId = 14;
      Returns:
      The bytes for tenantId.