JobSuspensionStateDto (Camunda Platform Javadocs 7.15.19-ee)

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

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

JobSuspensionStateDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_JOB_DEFINITION_ID`
`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_ID`
`static String`	`SERIALIZED_NAME_SUSPENDED`

Constructor Summary

Constructors
Constructor and Description

JobSuspensionStateDto()

Constructors
Constructor and Description
`JobSuspensionStateDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getJobDefinitionId()` The job definition id of the jobs to activate or suspend.
`String`	`getProcessDefinitionId()` The process definition id of the jobs to activate or suspend.
`String`	`getProcessDefinitionKey()` The process definition key of the jobs to activate or suspend.
`String`	`getProcessDefinitionTenantId()` Only activate or suspend jobs of a process definition which belongs to a tenant with the given id.
`Boolean`	`getProcessDefinitionWithoutTenantId()` Only activate or suspend jobs of a process definition which belongs to no tenant.
`String`	`getProcessInstanceId()` The process instance id of the jobs to activate or suspend.
`Boolean`	`getSuspended()` A Boolean value which indicates whether to activate or suspend a given instance (e.g.
`int`	`hashCode()`
`JobSuspensionStateDto`	`jobDefinitionId(String jobDefinitionId)`
`JobSuspensionStateDto`	`processDefinitionId(String processDefinitionId)`
`JobSuspensionStateDto`	`processDefinitionKey(String processDefinitionKey)`
`JobSuspensionStateDto`	`processDefinitionTenantId(String processDefinitionTenantId)`
`JobSuspensionStateDto`	`processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`JobSuspensionStateDto`	`processInstanceId(String processInstanceId)`
`void`	`setJobDefinitionId(String jobDefinitionId)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessDefinitionTenantId(String processDefinitionTenantId)`
`void`	`setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setSuspended(Boolean suspended)`
`JobSuspensionStateDto`	`suspended(Boolean suspended)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_JOB_DEFINITION_ID
```
public static final String SERIALIZED_NAME_JOB_DEFINITION_ID
```
    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_INSTANCE_ID
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_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_SUSPENDED
```
public static final String SERIALIZED_NAME_SUSPENDED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobSuspensionStateDto
```
public JobSuspensionStateDto()
```
- Method Detail
  - jobDefinitionId
```
public JobSuspensionStateDto jobDefinitionId(String jobDefinitionId)
```
  - getJobDefinitionId
```
@Nullable
public String getJobDefinitionId()
```
    The job definition id of the jobs to activate or suspend.
    
    Returns:
    
    jobDefinitionId
  - setJobDefinitionId
```
public void setJobDefinitionId(String jobDefinitionId)
```
  - processDefinitionId
```
public JobSuspensionStateDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
@Nullable
public String getProcessDefinitionId()
```
    The process definition id of the jobs to activate or suspend.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processInstanceId
```
public JobSuspensionStateDto processInstanceId(String processInstanceId)
```
  - getProcessInstanceId
```
@Nullable
public String getProcessInstanceId()
```
    The process instance id of the jobs to activate or suspend.
    
    Returns:
    
    processInstanceId
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - processDefinitionKey
```
public JobSuspensionStateDto processDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionKey
```
@Nullable
public String getProcessDefinitionKey()
```
    The process definition key of the jobs to activate or suspend.
    
    Returns:
    
    processDefinitionKey
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - processDefinitionTenantId
```
public JobSuspensionStateDto processDefinitionTenantId(String processDefinitionTenantId)
```
  - getProcessDefinitionTenantId
```
@Nullable
public String getProcessDefinitionTenantId()
```
    Only activate or suspend jobs of a process definition which belongs to a tenant with the given id. Works only when selecting with `processDefinitionKey`.
    
    Returns:
    
    processDefinitionTenantId
  - setProcessDefinitionTenantId
```
public void setProcessDefinitionTenantId(String processDefinitionTenantId)
```
  - processDefinitionWithoutTenantId
```
public JobSuspensionStateDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)
```
  - getProcessDefinitionWithoutTenantId
```
@Nullable
public Boolean getProcessDefinitionWithoutTenantId()
```
    Only activate or suspend jobs of a process definition which belongs to no tenant. Value may only be `true`, as `false` is the default behavior. Works only when selecting with `processDefinitionKey`.
    
    Returns:
    
    processDefinitionWithoutTenantId
  - setProcessDefinitionWithoutTenantId
```
public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)
```
  - suspended
```
public JobSuspensionStateDto 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 JobSuspensionStateDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_JOB_DEFINITION_ID

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_INSTANCE_ID

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_PROCESS_DEFINITION_TENANT_ID

SERIALIZED_NAME_PROCESS_DEFINITION_WITHOUT_TENANT_ID

SERIALIZED_NAME_SUSPENDED

Constructor Detail

JobSuspensionStateDto

Method Detail

jobDefinitionId

getJobDefinitionId

setJobDefinitionId

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processInstanceId

getProcessInstanceId

setProcessInstanceId

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processDefinitionTenantId

getProcessDefinitionTenantId

setProcessDefinitionTenantId

processDefinitionWithoutTenantId

getProcessDefinitionWithoutTenantId

setProcessDefinitionWithoutTenantId

suspended

getSuspended

setSuspended

equals

hashCode

toString