ProcessInstanceSuspensionStateDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.ProcessInstanceSuspensionStateDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class ProcessInstanceSuspensionStateDto
extends Object

ProcessInstanceSuspensionStateDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_IDS`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_QUERY`
`static String`	`SERIALIZED_NAME_SUSPENDED`

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceSuspensionStateDto()

Constructors
Constructor and Description
`ProcessInstanceSuspensionStateDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceSuspensionStateDto`	`addProcessInstanceIdsItem(String processInstanceIdsItem)`
`boolean`	`equals(Object o)`
`HistoricProcessInstanceQueryDto`	`getHistoricProcessInstanceQuery()` Get historicProcessInstanceQuery
`String`	`getProcessDefinitionId()` The process definition id of the process instances to activate or suspend.
`String`	`getProcessDefinitionKey()` The process definition key of the process instances to activate or suspend.
`String`	`getProcessDefinitionTenantId()` Only activate or suspend process instances of a process definition which belongs to a tenant with the given id.
`Boolean`	`getProcessDefinitionWithoutTenantId()` Only activate or suspend process instances of a process definition which belongs to no tenant.
`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.
`ProcessInstanceQueryDto`	`getProcessInstanceQuery()` Get processInstanceQuery
`Boolean`	`getSuspended()` A Boolean value which indicates whether to activate or suspend a given instance (e.g.
`int`	`hashCode()`
`ProcessInstanceSuspensionStateDto`	`historicProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)`
`ProcessInstanceSuspensionStateDto`	`processDefinitionId(String processDefinitionId)`
`ProcessInstanceSuspensionStateDto`	`processDefinitionKey(String processDefinitionKey)`
`ProcessInstanceSuspensionStateDto`	`processDefinitionTenantId(String processDefinitionTenantId)`
`ProcessInstanceSuspensionStateDto`	`processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`ProcessInstanceSuspensionStateDto`	`processInstanceIds(List<String> processInstanceIds)`
`ProcessInstanceSuspensionStateDto`	`processInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)`
`void`	`setHistoricProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessDefinitionTenantId(String processDefinitionTenantId)`
`void`	`setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`void`	`setProcessInstanceIds(List<String> processInstanceIds)`
`void`	`setProcessInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)`
`void`	`setSuspended(Boolean suspended)`
`ProcessInstanceSuspensionStateDto`	`suspended(Boolean suspended)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_PROCESS_DEFINITION_ID
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_DEFINITION_KEY
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_INSTANCE_IDS
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_IDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_INSTANCE_QUERY
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_QUERY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY
```
public static final String SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessInstanceSuspensionStateDto
```
public ProcessInstanceSuspensionStateDto()
```
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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)
```
  - 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, 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
  - setSuspended
```
public void setSuspended(Boolean suspended)
```
  - 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

Class ProcessInstanceSuspensionStateDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID

SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

SERIALIZED_NAME_PROCESS_INSTANCE_IDS

SERIALIZED_NAME_PROCESS_INSTANCE_QUERY

SERIALIZED_NAME_HISTORIC_PROCESS_INSTANCE_QUERY

SERIALIZED_NAME_SUSPENDED

Constructor Detail

ProcessInstanceSuspensionStateDto

Method Detail

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processDefinitionTenantId

getProcessDefinitionTenantId

setProcessDefinitionTenantId

processDefinitionWithoutTenantId

getProcessDefinitionWithoutTenantId

setProcessDefinitionWithoutTenantId

processInstanceIds

addProcessInstanceIdsItem

getProcessInstanceIds

setProcessInstanceIds

processInstanceQuery

getProcessInstanceQuery

setProcessInstanceQuery

historicProcessInstanceQuery

getHistoricProcessInstanceQuery

setHistoricProcessInstanceQuery

suspended

getSuspended

setSuspended

equals

hashCode

toString