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

public class JobDefinitionsSuspensionStateDto
extends Object

JobDefinitionsSuspensionStateDto

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_EXECUTION_DATE`
`static String`	`SERIALIZED_NAME_INCLUDE_JOBS`
`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_SUSPENDED`

Constructor Summary

Constructors
Constructor Description

JobDefinitionsSuspensionStateDto()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`JobDefinitionsSuspensionStateDto`	`executionDate(String executionDate)`
`String`	`getExecutionDate()`	The date on which the referenced job definitions will be activated or suspended.
`Boolean`	`getIncludeJobs()`	A `Boolean` value which indicates whether to activate or suspend also all jobs of the referenced job definitions.
`String`	`getProcessDefinitionId()`	The process definition id of the job definitions to activate or suspend.
`String`	`getProcessDefinitionKey()`	The process definition key of the job definitions to activate or suspend.
`String`	`getProcessDefinitionTenantId()`	Only activate or suspend job definitions of a process definition which belongs to a tenant with the given id.
`Boolean`	`getProcessDefinitionWithoutTenantId()`	Only activate or suspend job definitions of a process definition which belongs to no tenant.
`Boolean`	`getSuspended()`	A Boolean value which indicates whether to activate or suspend a given instance (e.g.
`int`	`hashCode()`
`JobDefinitionsSuspensionStateDto`	`includeJobs(Boolean includeJobs)`
`JobDefinitionsSuspensionStateDto`	`processDefinitionId(String processDefinitionId)`
`JobDefinitionsSuspensionStateDto`	`processDefinitionKey(String processDefinitionKey)`
`JobDefinitionsSuspensionStateDto`	`processDefinitionTenantId(String processDefinitionTenantId)`
`JobDefinitionsSuspensionStateDto`	`processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`void`	`setExecutionDate(String executionDate)`
`void`	`setIncludeJobs(Boolean includeJobs)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessDefinitionTenantId(String processDefinitionTenantId)`
`void`	`setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`void`	`setSuspended(Boolean suspended)`
`JobDefinitionsSuspensionStateDto`	`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_INCLUDE_JOBS
```
public static final String SERIALIZED_NAME_INCLUDE_JOBS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXECUTION_DATE
```
public static final String SERIALIZED_NAME_EXECUTION_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobDefinitionsSuspensionStateDto
```
public JobDefinitionsSuspensionStateDto()
```
- Method Detail
  - processDefinitionId
```
public JobDefinitionsSuspensionStateDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    The process definition id of the job definitions to activate or suspend.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processDefinitionKey
```
public JobDefinitionsSuspensionStateDto processDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
    The process definition key of the job definitions to activate or suspend.
    
    Returns:
    
    processDefinitionKey
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - processDefinitionTenantId
```
public JobDefinitionsSuspensionStateDto processDefinitionTenantId(String processDefinitionTenantId)
```
  - getProcessDefinitionTenantId
```
public String getProcessDefinitionTenantId()
```
    Only activate or suspend job definitions of a process definition which belongs to a tenant with the given id. Note that this parameter will only be considered in combination with `processDefinitionKey`.
    
    Returns:
    
    processDefinitionTenantId
  - setProcessDefinitionTenantId
```
public void setProcessDefinitionTenantId(String processDefinitionTenantId)
```
  - processDefinitionWithoutTenantId
```
public JobDefinitionsSuspensionStateDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)
```
  - getProcessDefinitionWithoutTenantId
```
public Boolean getProcessDefinitionWithoutTenantId()
```
    Only activate or suspend job definitions of a process definition which belongs to no tenant. Value may only be `true`, as `false` is the default behavior. Note that this parameter will only be considered in combination with `processDefinitionKey`.
    
    Returns:
    
    processDefinitionWithoutTenantId
  - setProcessDefinitionWithoutTenantId
```
public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)
```
  - includeJobs
```
public JobDefinitionsSuspensionStateDto includeJobs(Boolean includeJobs)
```
  - getIncludeJobs
```
public Boolean getIncludeJobs()
```
    A `Boolean` value which indicates whether to activate or suspend also all jobs of the referenced job definitions. When the value is set to `true`, all jobs of the provided job definitions will be activated or suspended and when the value is set to `false`, the suspension state of all jobs of the provided job definitions will not be updated.
    
    Returns:
    
    includeJobs
  - setIncludeJobs
```
public void setIncludeJobs(Boolean includeJobs)
```
  - executionDate
```
public JobDefinitionsSuspensionStateDto executionDate(String executionDate)
```
  - getExecutionDate
```
public String getExecutionDate()
```
    The date on which the referenced job definitions will be activated or suspended. If null, the suspension state of the given job definitions is updated immediately. By [default](https://docs.camunda.org/manual/7.18/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(String executionDate)
```
  - suspended
```
public JobDefinitionsSuspensionStateDto suspended(Boolean suspended)
```
  - getSuspended
```
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
  - 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 JobDefinitionsSuspensionStateDto

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_INCLUDE_JOBS

SERIALIZED_NAME_EXECUTION_DATE

SERIALIZED_NAME_SUSPENDED

Constructor Detail

JobDefinitionsSuspensionStateDto

Method Detail

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processDefinitionTenantId

getProcessDefinitionTenantId

setProcessDefinitionTenantId

processDefinitionWithoutTenantId

getProcessDefinitionWithoutTenantId

setProcessDefinitionWithoutTenantId

includeJobs

getIncludeJobs

setIncludeJobs

executionDate

getExecutionDate

setExecutionDate

suspended

getSuspended

setSuspended

equals

hashCode

toString