Package io.camunda.client.protocol.rest

Class VariableSearchResult

java.lang.Object
io.camunda.client.protocol.rest.VariableSearchResult
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class VariableSearchResult extends Object
VariableSearchResult

  • Field Details

  • Constructor Details

    • VariableSearchResult

      public VariableSearchResult()

  • Method Details

    • name

      public VariableSearchResult name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Name of this variable.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • tenantId

      public VariableSearchResult tenantId(@Nonnull String tenantId)

    • getTenantId

      @Nonnull public String getTenantId()
      Tenant ID of this variable.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull String tenantId)

    • variableKey

      public VariableSearchResult variableKey(@Nonnull String variableKey)

    • getVariableKey

      @Nonnull public String getVariableKey()
      The key for this variable.
      Returns:
      variableKey

    • setVariableKey

      public void setVariableKey(@Nonnull String variableKey)

    • scopeKey

      public VariableSearchResult scopeKey(@Nonnull String scopeKey)

    • getScopeKey

      @Nonnull public String getScopeKey()
      The key of the scope where this variable is directly defined. For process-level variables, this is the process instance key. For local variables, this is the key of the specific element instance (task, subprocess, gateway, event, etc.) where the variable is directly defined.
      Returns:
      scopeKey

    • setScopeKey

      public void setScopeKey(@Nonnull String scopeKey)

    • processInstanceKey

      public VariableSearchResult processInstanceKey(@Nonnull String processInstanceKey)

    • getProcessInstanceKey

      @Nonnull public String getProcessInstanceKey()
      The key of the process instance of this variable.
      Returns:
      processInstanceKey

    • setProcessInstanceKey

      public void setProcessInstanceKey(@Nonnull String processInstanceKey)

    • rootProcessInstanceKey

      public VariableSearchResult rootProcessInstanceKey(@Nullable String rootProcessInstanceKey)

    • getRootProcessInstanceKey

      @Nullable public String getRootProcessInstanceKey()
      The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.
      Returns:
      rootProcessInstanceKey

    • setRootProcessInstanceKey

      public void setRootProcessInstanceKey(@Nullable String rootProcessInstanceKey)

    • value

      public VariableSearchResult value(@Nonnull String value)

    • getValue

      @Nonnull public String getValue()
      Value of this variable. Can be truncated.
      Returns:
      value

    • setValue

      public void setValue(@Nonnull String value)

    • isTruncated

      public VariableSearchResult isTruncated(@Nonnull Boolean isTruncated)

    • getIsTruncated

      @Nonnull public Boolean getIsTruncated()
      Whether the value is truncated or not.
      Returns:
      isTruncated

    • setIsTruncated

      public void setIsTruncated(@Nonnull Boolean isTruncated)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object