Package io.camunda.zeebe.client.api.response

Interface ProcessInstanceResult

All Known Implementing Classes:
CreateProcessInstanceWithResultResponseImpl
@Deprecated public interface ProcessInstanceResult
Deprecated.
since 8.8 for removal in 8.9, replaced by ProcessInstanceResult

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBpmnProcessId()
    Deprecated.
    BPMN process id of the process which this instance was created for
    long
    getProcessDefinitionKey()
    Deprecated.
    Key of the process which this instance was created for
    long
    getProcessInstanceKey()
    Deprecated.
    Unique key of the created process instance on the partition
    String
    getTenantId()
    Deprecated.
    Tenant identifier that owns this process instance
    Object
    getVariable(String name)
    Deprecated.
    Variable returned by name after the process is completed.
    String
    getVariables()
    Deprecated.
    Variables returned after the process is completed.
    Map<String,Object>
    getVariablesAsMap()
    Deprecated.
    Variables returned after the process is completed.
    <T> T
    getVariablesAsType(Class<T> variableType)
    Deprecated.
    Variables returned after the process is completed.
    int
    getVersion()
    Deprecated.
    Version of the process which this instance was created for

  • Method Details

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Deprecated.
      Key of the process which this instance was created for

    • getBpmnProcessId

      String getBpmnProcessId()
      Deprecated.
      BPMN process id of the process which this instance was created for

    • getVersion

      int getVersion()
      Deprecated.
      Version of the process which this instance was created for

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Deprecated.
      Unique key of the created process instance on the partition

    • getVariables

      String getVariables()
      Deprecated.
      Variables returned after the process is completed.
      Returns:
      JSON-formatted variables

    • getVariablesAsMap

      Map<String,Object> getVariablesAsMap()
      Deprecated.
      Variables returned after the process is completed.
      Returns:
      de-serialized variables as map

    • getVariablesAsType

      <T> T getVariablesAsType(Class<T> variableType)
      Deprecated.
      Variables returned after the process is completed.
      Returns:
      de-serialized variables as the given type

    • getVariable

      Object getVariable(String name)
      Deprecated.
      Variable returned by name after the process is completed.
      Parameters:
      name - the name of the variable
      Returns:
      de-serialized variable value or null if the provided variable name is present among the available variables, otherwise throw a ClientException

    • getTenantId

      @ExperimentalApi("https://github.com/camunda/camunda/issues/13321") String getTenantId()
      Deprecated.
      Tenant identifier that owns this process instance