ProcessDefinitionSuspensionStateDto (Camunda Platform Javadocs 7.15.19-ee)

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

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

ProcessDefinitionSuspensionStateDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_EXECUTION_DATE`
`static String`	`SERIALIZED_NAME_INCLUDE_PROCESS_INSTANCES`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_SUSPENDED`

Constructor Summary

Constructors
Constructor and Description

ProcessDefinitionSuspensionStateDto()

Constructors
Constructor and Description
`ProcessDefinitionSuspensionStateDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`ProcessDefinitionSuspensionStateDto`	`executionDate(Date executionDate)`
`Date`	`getExecutionDate()` The date on which all process definitions with the given key will be activated or suspended.
`Boolean`	`getIncludeProcessInstances()` A `Boolean` value which indicates whether to activate or suspend also all process instances of the process definitions with the given key.
`String`	`getProcessDefinitionId()` The id of the process definitions to activate or suspend.
`String`	`getProcessDefinitionKey()` The key of the process definitions to activate or suspend.
`Boolean`	`getSuspended()` A `Boolean` value which indicates whether to activate or suspend all process definitions with the given key.
`int`	`hashCode()`
`ProcessDefinitionSuspensionStateDto`	`includeProcessInstances(Boolean includeProcessInstances)`
`ProcessDefinitionSuspensionStateDto`	`processDefinitionId(String processDefinitionId)`
`ProcessDefinitionSuspensionStateDto`	`processDefinitionKey(String processDefinitionKey)`
`void`	`setExecutionDate(Date executionDate)`
`void`	`setIncludeProcessInstances(Boolean includeProcessInstances)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setSuspended(Boolean suspended)`
`ProcessDefinitionSuspensionStateDto`	`suspended(Boolean suspended)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
  - 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_INCLUDE_PROCESS_INSTANCES
```
public static final String SERIALIZED_NAME_INCLUDE_PROCESS_INSTANCES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXECUTION_DATE
```
public static final String SERIALIZED_NAME_EXECUTION_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcessDefinitionSuspensionStateDto
```
public ProcessDefinitionSuspensionStateDto()
```
- Method Detail
  - suspended
```
public ProcessDefinitionSuspensionStateDto suspended(Boolean suspended)
```
  - getSuspended
```
@Nullable
public Boolean getSuspended()
```
    A `Boolean` value which indicates whether to activate or suspend all process definitions with the given key. When the value is set to `true`, all process definitions with the given key will be suspended and when the value is set to `false`, all process definitions with the given key will be activated.
    
    Returns:
    
    suspended
  - setSuspended
```
public void setSuspended(Boolean suspended)
```
  - processDefinitionId
```
public ProcessDefinitionSuspensionStateDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
@Nullable
public String getProcessDefinitionId()
```
    The id of the process definitions to activate or suspend.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processDefinitionKey
```
public ProcessDefinitionSuspensionStateDto processDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionKey
```
@Nullable
public String getProcessDefinitionKey()
```
    The key of the process definitions to activate or suspend.
    
    Returns:
    
    processDefinitionKey
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - includeProcessInstances
```
public ProcessDefinitionSuspensionStateDto includeProcessInstances(Boolean includeProcessInstances)
```
  - getIncludeProcessInstances
```
@Nullable
public Boolean getIncludeProcessInstances()
```
    A `Boolean` value which indicates whether to activate or suspend also all process instances of the process definitions with the given key. When the value is set to `true`, all process instances of the process definitions with the given key will be activated or suspended and when the value is set to `false`, the suspension state of all process instances of the process definitions with the given key will not be updated.
    
    Returns:
    
    includeProcessInstances
  - setIncludeProcessInstances
```
public void setIncludeProcessInstances(Boolean includeProcessInstances)
```
  - executionDate
```
public ProcessDefinitionSuspensionStateDto executionDate(Date executionDate)
```
  - getExecutionDate
```
@Nullable
public Date getExecutionDate()
```
    The date on which all process definitions with the given key will be activated or suspended. If `null`, the suspension state of all process definitions with the given key is updated immediately. By [default](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
    
    Returns:
    
    executionDate
  - setExecutionDate
```
public void setExecutionDate(Date executionDate)
```
  - 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 ProcessDefinitionSuspensionStateDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_SUSPENDED

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_INCLUDE_PROCESS_INSTANCES

SERIALIZED_NAME_EXECUTION_DATE

Constructor Detail

ProcessDefinitionSuspensionStateDto

Method Detail

suspended

getSuspended

setSuspended

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

includeProcessInstances

getIncludeProcessInstances

setIncludeProcessInstances

executionDate

getExecutionDate

setExecutionDate

equals

hashCode

toString