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

Class ProcessInstanceSuspensionStateDto

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

  • Field Details

    • JSON_PROPERTY_SUSPENDED

      public static final String JSON_PROPERTY_SUSPENDED
      See Also:

    • JSON_PROPERTY_PROCESS_DEFINITION_ID

      public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID
      See Also:

    • JSON_PROPERTY_PROCESS_DEFINITION_KEY

      public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY
      See Also:

    • JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID

      public static final String JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID
      See Also:

    • JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID

      public static final String JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID
      See Also:

    • JSON_PROPERTY_PROCESS_INSTANCE_IDS

      public static final String JSON_PROPERTY_PROCESS_INSTANCE_IDS
      See Also:

    • JSON_PROPERTY_PROCESS_INSTANCE_QUERY

      public static final String JSON_PROPERTY_PROCESS_INSTANCE_QUERY
      See Also:

    • JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY

      public static final String JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY
      See Also:

  • Constructor Details

    • ProcessInstanceSuspensionStateDto

      public ProcessInstanceSuspensionStateDto()

  • Method Details

    • suspended

      public ProcessInstanceSuspensionStateDto suspended(Boolean suspended)

    • getSuspended

      @Nullable public Boolean getSuspended()
      A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated.
      Returns:
      suspended

    • getSuspended_JsonNullable

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

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended)

    • setSuspended

      public void setSuspended(Boolean suspended)

    • processDefinitionId

      public ProcessInstanceSuspensionStateDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The process definition id of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

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

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionKey

      public ProcessInstanceSuspensionStateDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The process definition key of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionTenantId`, and `processDefinitionWithoutTenantId`.
      Returns:
      processDefinitionKey

    • getProcessDefinitionKey_JsonNullable

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

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey)

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionTenantId

      public ProcessInstanceSuspensionStateDto processDefinitionTenantId(String processDefinitionTenantId)

    • getProcessDefinitionTenantId

      @Nullable public String getProcessDefinitionTenantId()
      Only activate or suspend process instances of a process definition which belongs to a tenant with the given id. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionWithoutTenantId`.
      Returns:
      processDefinitionTenantId

    • getProcessDefinitionTenantId_JsonNullable

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

    • setProcessDefinitionTenantId_JsonNullable

      public void setProcessDefinitionTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionTenantId)

    • setProcessDefinitionTenantId

      public void setProcessDefinitionTenantId(String processDefinitionTenantId)

    • processDefinitionWithoutTenantId

      public ProcessInstanceSuspensionStateDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

    • getProcessDefinitionWithoutTenantId

      @Nullable public Boolean getProcessDefinitionWithoutTenantId()
      Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionTenantId`.
      Returns:
      processDefinitionWithoutTenantId

    • getProcessDefinitionWithoutTenantId_JsonNullable

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

    • setProcessDefinitionWithoutTenantId_JsonNullable

      public void setProcessDefinitionWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> processDefinitionWithoutTenantId)

    • setProcessDefinitionWithoutTenantId

      public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

    • processInstanceIds

      public ProcessInstanceSuspensionStateDto processInstanceIds(List<String> processInstanceIds)

    • addProcessInstanceIdsItem

      public ProcessInstanceSuspensionStateDto addProcessInstanceIdsItem(String processInstanceIdsItem)

    • getProcessInstanceIds

      @Nullable public List<String> getProcessInstanceIds()
      A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation. **Note**: This parameter can be used only with combination of `suspended`, `processInstanceQuery`, and `historicProcessInstanceQuery`.
      Returns:
      processInstanceIds

    • getProcessInstanceIds_JsonNullable

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

    • setProcessInstanceIds_JsonNullable

      public void setProcessInstanceIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processInstanceIds)

    • setProcessInstanceIds

      public void setProcessInstanceIds(List<String> processInstanceIds)

    • processInstanceQuery

      public ProcessInstanceSuspensionStateDto processInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)

    • getProcessInstanceQuery

      @Nullable public ProcessInstanceQueryDto getProcessInstanceQuery()
      Get processInstanceQuery
      Returns:
      processInstanceQuery

    • setProcessInstanceQuery

      public void setProcessInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)

    • historicProcessInstanceQuery

      public ProcessInstanceSuspensionStateDto historicProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • getHistoricProcessInstanceQuery

      @Nullable public HistoricProcessInstanceQueryDto getHistoricProcessInstanceQuery()
      Get historicProcessInstanceQuery
      Returns:
      historicProcessInstanceQuery

    • setHistoricProcessInstanceQuery

      public void setHistoricProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • 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