Package org.camunda.community.rest.client.dto

Class StartProcessInstanceDto

java.lang.Object
org.camunda.community.rest.client.dto.StartProcessInstanceDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class StartProcessInstanceDto extends Object
StartProcessInstanceDto

  • Field Details

  • Constructor Details

    • StartProcessInstanceDto

      public StartProcessInstanceDto()

  • Method Details

    • businessKey

      public StartProcessInstanceDto businessKey(String businessKey)

    • getBusinessKey

      @Nullable public String getBusinessKey()
      The business key of the process instance.
      Returns:
      businessKey

    • getBusinessKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getBusinessKey_JsonNullable()

    • setBusinessKey_JsonNullable

      public void setBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> businessKey)

    • setBusinessKey

      public void setBusinessKey(String businessKey)

    • variables

      public StartProcessInstanceDto variables(Map<String,VariableValueDto> variables)

    • putVariablesItem

      public StartProcessInstanceDto putVariablesItem(String key, VariableValueDto variablesItem)

    • getVariables

      @Nullable public Map<String,VariableValueDto> getVariables()
      Returns:
      variables

    • getVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> getVariables_JsonNullable()

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> variables)

    • setVariables

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

    • caseInstanceId

      public StartProcessInstanceDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      The case instance id the process instance is to be initialized with.
      Returns:
      caseInstanceId

    • getCaseInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCaseInstanceId_JsonNullable()

    • setCaseInstanceId_JsonNullable

      public void setCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseInstanceId)

    • setCaseInstanceId

      public void setCaseInstanceId(String caseInstanceId)

    • startInstructions

      public StartProcessInstanceDto startInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)

    • addStartInstructionsItem

      public StartProcessInstanceDto addStartInstructionsItem(ProcessInstanceModificationInstructionDto startInstructionsItem)

    • getStartInstructions

      @Nullable public List<ProcessInstanceModificationInstructionDto> getStartInstructions()
      **Optional**. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.
      Returns:
      startInstructions

    • getStartInstructions_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<ProcessInstanceModificationInstructionDto>> getStartInstructions_JsonNullable()

    • setStartInstructions_JsonNullable

      public void setStartInstructions_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<ProcessInstanceModificationInstructionDto>> startInstructions)

    • setStartInstructions

      public void setStartInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)

    • skipCustomListeners

      public StartProcessInstanceDto skipCustomListeners(Boolean skipCustomListeners)

    • getSkipCustomListeners

      @Nullable public Boolean getSkipCustomListeners()
      Skip execution listener invocation for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
      Returns:
      skipCustomListeners

    • getSkipCustomListeners_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSkipCustomListeners_JsonNullable()

    • setSkipCustomListeners_JsonNullable

      public void setSkipCustomListeners_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> skipCustomListeners)

    • setSkipCustomListeners

      public void setSkipCustomListeners(Boolean skipCustomListeners)

    • skipIoMappings

      public StartProcessInstanceDto skipIoMappings(Boolean skipIoMappings)

    • getSkipIoMappings

      @Nullable public Boolean getSkipIoMappings()
      Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.21/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
      Returns:
      skipIoMappings

    • getSkipIoMappings_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSkipIoMappings_JsonNullable()

    • setSkipIoMappings_JsonNullable

      public void setSkipIoMappings_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> skipIoMappings)

    • setSkipIoMappings

      public void setSkipIoMappings(Boolean skipIoMappings)

    • withVariablesInReturn

      public StartProcessInstanceDto withVariablesInReturn(Boolean withVariablesInReturn)

    • getWithVariablesInReturn

      @Nullable public Boolean getWithVariablesInReturn()
      Indicates if the variables, which was used by the process instance during execution, should be returned. Default value: `false`
      Returns:
      withVariablesInReturn

    • getWithVariablesInReturn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithVariablesInReturn_JsonNullable()

    • setWithVariablesInReturn_JsonNullable

      public void setWithVariablesInReturn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withVariablesInReturn)

    • setWithVariablesInReturn

      public void setWithVariablesInReturn(Boolean withVariablesInReturn)

    • 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