Package io.camunda.zeebe.client.protocol.rest

Class ProcessInstanceCreationInstruction

java.lang.Object
io.camunda.zeebe.client.protocol.rest.ProcessInstanceCreationInstruction
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-08-04T12:37:47.170113265Z[GMT]", comments="Generator version: 7.8.0") public class ProcessInstanceCreationInstruction extends Object
ProcessInstanceCreationInstruction

  • Field Details

  • Constructor Details

    • ProcessInstanceCreationInstruction

      public ProcessInstanceCreationInstruction()

  • Method Details

    • processDefinitionKey

      public ProcessInstanceCreationInstruction processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint. Cannot be used together with processDefinitionId.
      Returns:
      processDefinitionKey

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionId

      public ProcessInstanceCreationInstruction processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The BPMN process ID of the process definition to start an instance of. Cannot be used together with processDefinitionKey.
      Returns:
      processDefinitionId

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionVersion

      public ProcessInstanceCreationInstruction processDefinitionVersion(Integer processDefinitionVersion)

    • getProcessDefinitionVersion

      @Nullable public Integer getProcessDefinitionVersion()
      The version of the process. Only considered when a processDefinitionId is provided. By default, the latest version of the process is used.
      Returns:
      processDefinitionVersion

    • setProcessDefinitionVersion

      public void setProcessDefinitionVersion(Integer processDefinitionVersion)

    • variables

      public ProcessInstanceCreationInstruction variables(Map<String,Object> variables)

    • putVariablesItem

      public ProcessInstanceCreationInstruction putVariablesItem(String key, Object variablesItem)

    • getVariables

      @Nullable public Map<String,Object> getVariables()
      JSON object that will instantiate the variables for the root variable scope of the process instance.
      Returns:
      variables

    • setVariables

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

    • tenantId

      public ProcessInstanceCreationInstruction tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The tenant ID of the process definition.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(String tenantId)

    • operationReference

      public ProcessInstanceCreationInstruction operationReference(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(Long operationReference)

    • startInstructions

      public ProcessInstanceCreationInstruction startInstructions(List<ProcessInstanceCreationStartInstruction> startInstructions)

    • addStartInstructionsItem

      public ProcessInstanceCreationInstruction addStartInstructionsItem(ProcessInstanceCreationStartInstruction startInstructionsItem)

    • getStartInstructions

      @Nullable public List<ProcessInstanceCreationStartInstruction> getStartInstructions()
      List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.
      Returns:
      startInstructions

    • setStartInstructions

      public void setStartInstructions(List<ProcessInstanceCreationStartInstruction> startInstructions)

    • awaitCompletion

      public ProcessInstanceCreationInstruction awaitCompletion(Boolean awaitCompletion)

    • getAwaitCompletion

      @Nullable public Boolean getAwaitCompletion()
      Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. This can lead to a 504 response status. Disabled by default.
      Returns:
      awaitCompletion

    • setAwaitCompletion

      public void setAwaitCompletion(Boolean awaitCompletion)

    • fetchVariables

      public ProcessInstanceCreationInstruction fetchVariables(List<String> fetchVariables)

    • addFetchVariablesItem

      public ProcessInstanceCreationInstruction addFetchVariablesItem(String fetchVariablesItem)

    • getFetchVariables

      @Nullable public List<String> getFetchVariables()
      List of variables names to be included in the response. If empty, all visible variables in the root scope will be returned.
      Returns:
      fetchVariables

    • setFetchVariables

      public void setFetchVariables(List<String> fetchVariables)

    • requestTimeout

      public ProcessInstanceCreationInstruction requestTimeout(Long requestTimeout)

    • getRequestTimeout

      @Nullable public Long getRequestTimeout()
      Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.
      Returns:
      requestTimeout

    • setRequestTimeout

      public void setRequestTimeout(Long requestTimeout)

    • 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