ExternalTaskFailureDto (Camunda Platform Javadocs 7.15.19-ee)

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

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

ExternalTaskFailureDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ERROR_DETAILS`
`static String`	`SERIALIZED_NAME_ERROR_MESSAGE`
`static String`	`SERIALIZED_NAME_LOCAL_VARIABLES`
`static String`	`SERIALIZED_NAME_RETRIES`
`static String`	`SERIALIZED_NAME_RETRY_TIMEOUT`
`static String`	`SERIALIZED_NAME_VARIABLES`
`static String`	`SERIALIZED_NAME_WORKER_ID`

Constructor Summary

Constructors
Constructor and Description

ExternalTaskFailureDto()

Constructors
Constructor and Description
`ExternalTaskFailureDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`ExternalTaskFailureDto`	`errorDetails(String errorDetails)`
`ExternalTaskFailureDto`	`errorMessage(String errorMessage)`
`String`	`getErrorDetails()` A detailed error description.
`String`	`getErrorMessage()` An message indicating the reason of the failure.
`Map<String,VariableValueDto>`	`getLocalVariables()` A JSON object containing local variable key-value pairs.
`Integer`	`getRetries()` A number of how often the task should be retried.
`Long`	`getRetryTimeout()` A timeout in milliseconds before the external task becomes available again for fetching.
`Map<String,VariableValueDto>`	`getVariables()` A JSON object containing variable key-value pairs.
`String`	`getWorkerId()` Mandatory. The ID of the worker who is performing the operation on the external task.
`int`	`hashCode()`
`ExternalTaskFailureDto`	`localVariables(Map<String,VariableValueDto> localVariables)`
`ExternalTaskFailureDto`	`putLocalVariablesItem(String key, VariableValueDto localVariablesItem)`
`ExternalTaskFailureDto`	`putVariablesItem(String key, VariableValueDto variablesItem)`
`ExternalTaskFailureDto`	`retries(Integer retries)`
`ExternalTaskFailureDto`	`retryTimeout(Long retryTimeout)`
`void`	`setErrorDetails(String errorDetails)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setLocalVariables(Map<String,VariableValueDto> localVariables)`
`void`	`setRetries(Integer retries)`
`void`	`setRetryTimeout(Long retryTimeout)`
`void`	`setVariables(Map<String,VariableValueDto> variables)`
`void`	`setWorkerId(String workerId)`
`String`	`toString()`
`ExternalTaskFailureDto`	`variables(Map<String,VariableValueDto> variables)`
`ExternalTaskFailureDto`	`workerId(String workerId)`

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

Field Detail
- SERIALIZED_NAME_ERROR_MESSAGE
```
public static final String SERIALIZED_NAME_ERROR_MESSAGE
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ERROR_DETAILS
```
public static final String SERIALIZED_NAME_ERROR_DETAILS
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_RETRIES
```
public static final String SERIALIZED_NAME_RETRIES
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_RETRY_TIMEOUT
```
public static final String SERIALIZED_NAME_RETRY_TIMEOUT
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_VARIABLES
```
public static final String SERIALIZED_NAME_VARIABLES
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_LOCAL_VARIABLES
```
public static final String SERIALIZED_NAME_LOCAL_VARIABLES
```
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_WORKER_ID
```
public static final String SERIALIZED_NAME_WORKER_ID
```
  See Also:
  
  Constant Field Values

Constructor Detail
- ExternalTaskFailureDto
```
public ExternalTaskFailureDto()
```

Method Detail

errorMessage

public ExternalTaskFailureDto errorMessage(String errorMessage)

getErrorMessage
```
@Nullable
public String getErrorMessage()
```
An message indicating the reason of the failure.

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(String errorMessage)

errorDetails

public ExternalTaskFailureDto errorDetails(String errorDetails)

getErrorDetails
```
@Nullable
public String getErrorDetails()
```
A detailed error description.

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(String errorDetails)

retries

public ExternalTaskFailureDto retries(Integer retries)

getRetries
```
@Nullable
public Integer getRetries()
```
A number of how often the task should be retried. Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the `errorMessage` parameter.

Returns:

retries

setRetries

public void setRetries(Integer retries)

retryTimeout

public ExternalTaskFailureDto retryTimeout(Long retryTimeout)

getRetryTimeout
```
@Nullable
public Long getRetryTimeout()
```
A timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.

Returns:

retryTimeout

setRetryTimeout

public void setRetryTimeout(Long retryTimeout)

variables

public ExternalTaskFailureDto variables(Map<String,VariableValueDto> variables)

putVariablesItem

public ExternalTaskFailureDto putVariablesItem(String key,
                                               VariableValueDto variablesItem)

getVariables
```
@Nullable
public Map<String,VariableValueDto> getVariables()
```
A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:

Returns:

variables

setVariables

public void setVariables(Map<String,VariableValueDto> variables)

localVariables

public ExternalTaskFailureDto localVariables(Map<String,VariableValueDto> localVariables)

putLocalVariablesItem

public ExternalTaskFailureDto putLocalVariablesItem(String key,
                                                    VariableValueDto localVariablesItem)

getLocalVariables
```
@Nullable
public Map<String,VariableValueDto> getLocalVariables()
```
A JSON object containing local variable key-value pairs. Local variables are set only in the scope of external task. Each key is a variable name and each value a JSON variable value object with the following properties:

Returns:

localVariables

setLocalVariables

public void setLocalVariables(Map<String,VariableValueDto> localVariables)

workerId

public ExternalTaskFailureDto workerId(String workerId)

getWorkerId
```
@Nullable
public String getWorkerId()
```
**Mandatory.** The ID of the worker who is performing the operation on the external task. If the task is already locked, must match the id of the worker who has most recently locked the task.

Returns:

workerId

setWorkerId

public void setWorkerId(String workerId)

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 ExternalTaskFailureDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ERROR_MESSAGE

SERIALIZED_NAME_ERROR_DETAILS

SERIALIZED_NAME_RETRIES

SERIALIZED_NAME_RETRY_TIMEOUT

SERIALIZED_NAME_VARIABLES

SERIALIZED_NAME_LOCAL_VARIABLES

SERIALIZED_NAME_WORKER_ID

Constructor Detail

ExternalTaskFailureDto

Method Detail

errorMessage

getErrorMessage

setErrorMessage

errorDetails

getErrorDetails

setErrorDetails

retries

getRetries

setRetries

retryTimeout

getRetryTimeout

setRetryTimeout

variables

putVariablesItem

getVariables

setVariables

localVariables

putLocalVariablesItem

getLocalVariables

setLocalVariables

workerId

getWorkerId

setWorkerId

equals

hashCode

toString