Package io.camunda.client.protocol.rest
Class JobFailRequest
java.lang.Object
io.camunda.client.protocol.rest.JobFailRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2025-02-25T13:39:08.081076719Z[GMT]",
comments="Generator version: 7.10.0")
public class JobFailRequest
extends Object
JobFailRequest
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanerrorMessage(String errorMessage) An optional message describing why the job failed.The amount of retries the job should have leftThe backoff timeout (in ms) for the next retry.JSON object that will instantiate the variables at the local scope of the job's associated task.inthashCode()putVariablesItem(String key, Object variablesItem) retryBackOff(Long retryBackOff) voidsetErrorMessage(String errorMessage) voidsetRetries(Integer retries) voidsetRetryBackOff(Long retryBackOff) voidsetVariables(Map<String, Object> variables) toString()Convert the instance into URL query string.toUrlQueryString(String prefix) Convert the instance into URL query string.
-
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:
-
-
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 message describing why the job failed. This is particularly useful if a job runs out of retries and an incident is raised, as this message can help explain why an incident was raised.- Returns:
- errorMessage
-
setErrorMessage
-
retryBackOff
-
getRetryBackOff
The backoff timeout (in ms) for the next retry.- 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
-
equals
-
hashCode
public int hashCode() -
toString
-
toUrlQueryString
Convert the instance into URL query string.- Returns:
- URL query string
-
toUrlQueryString
Convert the instance into URL query string.- Parameters:
prefix- prefix of the query string- Returns:
- URL query string
-