Package io.camunda.zeebe.gateway.protocol.rest

Class JobFailRequest

java.lang.Object

io.camunda.zeebe.gateway.protocol.rest.JobFailRequest

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2024-10-11T17:26:39.504605721Z[GMT]",
           comments="Generator version: 7.8.0")
public class JobFailRequest
extends Object

JobFailRequest

Constructor Summary

Constructors

Constructor	Description
JobFailRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
JobFailRequest	errorMessage(String errorMessage)
String	getErrorMessage()	An optional message describing why the job failed.
Integer	getRetries()	The amount of retries the job should have left
Long	getRetryBackOff()	The backoff timeout (in ms) for the next retry.
Map<String,Object>	getVariables()	JSON object that will instantiate the variables at the local scope of the job's associated task.
int	hashCode()
JobFailRequest	putVariablesItem(String key, Object variablesItem)
JobFailRequest	retries(Integer retries)
JobFailRequest	retryBackOff(Long retryBackOff)
void	setErrorMessage(String errorMessage)
void	setRetries(Integer retries)
void	setRetryBackOff(Long retryBackOff)
void	setVariables(Map<String,Object> variables)
String	toString()
JobFailRequest	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JobFailRequest

public JobFailRequest()

Method Details

retries

public JobFailRequest retries(Integer retries)

getRetries

public Integer getRetries()

The amount of retries the job should have left

Returns:

retries

setRetries

public void setRetries(Integer retries)

errorMessage

public JobFailRequest errorMessage(String errorMessage)

getErrorMessage

public String 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

public void setErrorMessage(String errorMessage)

retryBackOff

public JobFailRequest retryBackOff(Long retryBackOff)

getRetryBackOff

public Long getRetryBackOff()

The backoff timeout (in ms) for the next retry.

Returns:

retryBackOff

setRetryBackOff

public void setRetryBackOff(Long retryBackOff)

variables

public JobFailRequest variables(Map<String,Object> variables)

putVariablesItem

public JobFailRequest putVariablesItem(String key,
 Object variablesItem)

getVariables

public Map<String,Object> getVariables()

JSON object that will instantiate the variables at the local scope of the job's associated task.

Returns:

variables

setVariables

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

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