Package io.camunda.client.protocol.rest

Class SetVariableRequest

java.lang.Object
io.camunda.client.protocol.rest.SetVariableRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-06-04T12:01:10.435788262Z[GMT]", comments="Generator version: 7.12.0") public class SetVariableRequest extends Object
SetVariableRequest

  • Field Details

  • Constructor Details

    • SetVariableRequest

      public SetVariableRequest()

  • Method Details

    • variables

      public SetVariableRequest variables(@Nonnull Map<String,Object> variables)

    • putVariablesItem

      public SetVariableRequest putVariablesItem(String key, Object variablesItem)

    • getVariables

      @Nonnull public Map<String,Object> getVariables()
      JSON object representing the variables to set in the element’s scope.
      Returns:
      variables

    • setVariables

      public void setVariables(@Nonnull Map<String,Object> variables)

    • local

      public SetVariableRequest local(@Nullable Boolean local)

    • getLocal

      @Nullable public Boolean getLocal()
      If set to true, the variables are merged strictly into the local scope (as specified by the `elementInstanceKey`). Otherwise, the variables are propagated to upper scopes and set at the outermost one. Let’s consider the following example: There are two scopes '1' and '2'. Scope '1' is the parent scope of '2'. The effective variables of the scopes are: 1 => { \"foo\" : 2 } 2 => { \"bar\" : 1 } An update request with elementInstanceKey as '2', variables { \"foo\" : 5 }, and local set to true leaves scope '1' unchanged and adjusts scope '2' to { \"bar\" : 1, \"foo\" 5 }. By default, with local set to false, scope '1' will be { \"foo\": 5 } and scope '2' will be { \"bar\" : 1 }.
      Returns:
      local

    • setLocal

      public void setLocal(@Nullable Boolean local)

    • operationReference

      public SetVariableRequest operationReference(@Nullable Long operationReference)

    • getOperationReference

      @Nullable public Long getOperationReference()
      A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided. minimum: 1
      Returns:
      operationReference

    • setOperationReference

      public void setOperationReference(@Nullable Long operationReference)

    • 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

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string