Package io.camunda.client.protocol.rest
Class JobFailRequest
java.lang.Object
io.camunda.client.protocol.rest.JobFailRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class JobFailRequest
extends Object
JobFailRequest
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanerrorMessage(String errorMessage) An optional error message describing why the job failed; if not provided, an empty string is used.The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`.The amount of retries the job should have leftAn optional retry back off for the failed job.JSON object that will instantiate the variables at the local scope of the job's associated task.inthashCode()leaseToken(String leaseToken) putVariablesItem(String key, Object variablesItem) retryBackOff(Long retryBackOff) voidsetErrorMessage(String errorMessage) voidsetLeaseToken(String leaseToken) voidsetRetries(Integer retries) voidsetRetryBackOff(Long retryBackOff) voidsetVariables(Map<String, Object> variables) toString()
-
Field Details
-
JSON_PROPERTY_RETRIES
- See Also:
-
JSON_PROPERTY_ERROR_MESSAGE
- See Also:
-
JSON_PROPERTY_RETRY_BACK_OFF
- See Also:
-
JSON_PROPERTY_VARIABLES
- See Also:
-
JSON_PROPERTY_LEASE_TOKEN
- See Also:
-
-
Constructor Details
-
JobFailRequest
public JobFailRequest()
-
-
Method Details
-
retries
-
getRetries
The amount of retries the job should have left- Returns:
- retries
-
setRetries
-
errorMessage
-
getErrorMessage
An optional error message describing why the job failed; if not provided, an empty string is used.- Returns:
- errorMessage
-
setErrorMessage
-
retryBackOff
-
getRetryBackOff
An optional retry back off for the failed job. The job will not be retryable before the current time plus the back off time. The default is 0 which means the job is retryable immediately.- Returns:
- retryBackOff
-
setRetryBackOff
-
variables
-
putVariablesItem
-
getVariables
JSON object that will instantiate the variables at the local scope of the job's associated task.- Returns:
- variables
-
setVariables
-
leaseToken
-
getLeaseToken
The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`. For a leased job, the matching token must be supplied to prove the command comes from the worker that holds the current lease; a command with no token is rejected. A command carrying a stale token is likewise rejected, fencing the job against a superseded activation (for example, after the job timed out or failed and was re-activated by another worker). A job that was activated without a lease requires no token.- Returns:
- leaseToken
-
setLeaseToken
-
equals
-
hashCode
public int hashCode() -
toString
-