Package io.camunda.client.api.search.response

Interface Variable

All Known Implementing Classes:
VariableImpl
public interface Variable

  • Method Details

    • getVariableKey

      Long getVariableKey()

    • getName

      String getName()

    • getValue

      String getValue()

    • getScopeKey

      Long getScopeKey()

    • getProcessInstanceKey

      Long getProcessInstanceKey()

    • getRootProcessInstanceKey

      Long getRootProcessInstanceKey()
      Returns the key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy.

      Note: This field is null for process instance hierarchies created before version 8.9.

      Returns:
      the root process instance key, or null for data created before version 8.9

    • getTenantId

      String getTenantId()

    • isTruncated

      Boolean isTruncated()

    • getValueAsType

      <T> T getValueAsType(Class<T> type)
      Deserializes the variable's JSON value into the given type.
      Type Parameters:
      T - the target type
      Parameters:
      type - the class to deserialize the value into
      Returns:
      the deserialized value
      Throws:
      IllegalStateException - if the variable value is truncated