Package io.camunda.client.protocol.rest

Class JobSearchResult

java.lang.Object

io.camunda.client.protocol.rest.JobSearchResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class JobSearchResult
extends Object

JobSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CUSTOM_HEADERS
static final String	JSON_PROPERTY_DEADLINE
static final String	JSON_PROPERTY_DENIED_REASON
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_END_TIME
static final String	JSON_PROPERTY_ERROR_CODE
static final String	JSON_PROPERTY_ERROR_MESSAGE
static final String	JSON_PROPERTY_HAS_FAILED_WITH_RETRIES_LEFT
static final String	JSON_PROPERTY_IS_DENIED
static final String	JSON_PROPERTY_JOB_KEY
static final String	JSON_PROPERTY_KIND
static final String	JSON_PROPERTY_LISTENER_EVENT_TYPE
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_RETRIES
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_WORKER

Constructor Summary

Constructors

Constructor	Description
JobSearchResult()

Method Summary

Modifier and Type	Method	Description
JobSearchResult	customHeaders(Map<String,String> customHeaders)
JobSearchResult	deadline(String deadline)
JobSearchResult	deniedReason(String deniedReason)
JobSearchResult	elementId(String elementId)
JobSearchResult	elementInstanceKey(String elementInstanceKey)
JobSearchResult	endTime(String endTime)
boolean	equals(Object o)
JobSearchResult	errorCode(String errorCode)
JobSearchResult	errorMessage(String errorMessage)
Map<String,String>	getCustomHeaders()	A set of custom headers defined during modelling.
String	getDeadline()	When the job can be activated.
String	getDeniedReason()	The reason provided by the user task listener for denying the work.
String	getElementId()	The element ID associated with the job.
String	getElementInstanceKey()	The element instance key associated with the job.
String	getEndTime()	When the job ended.
String	getErrorCode()	The error code provided for the failed job.
String	getErrorMessage()	The error message that provides additional context for a failed job.
Boolean	getHasFailedWithRetriesLeft()	Indicates whether the job has failed with retries left.
Boolean	getIsDenied()	Indicates whether the user task listener denies the work.
String	getJobKey()	The key, a unique identifier for the job.
JobKindEnum	getKind()	Get kind
JobListenerEventTypeEnum	getListenerEventType()	Get listenerEventType
String	getProcessDefinitionId()	The process definition ID associated with the job.
String	getProcessDefinitionKey()	The process definition key associated with the job.
String	getProcessInstanceKey()	The process instance key associated with the job.
Integer	getRetries()	The amount of retries left to this job.
JobStateEnum	getState()	Get state
String	getTenantId()	The tenant ID.
String	getType()	The type of the job.
String	getWorker()	The name of the worker of this job.
JobSearchResult	hasFailedWithRetriesLeft(Boolean hasFailedWithRetriesLeft)
int	hashCode()
JobSearchResult	isDenied(Boolean isDenied)
JobSearchResult	jobKey(String jobKey)
JobSearchResult	kind(JobKindEnum kind)
JobSearchResult	listenerEventType(JobListenerEventTypeEnum listenerEventType)
JobSearchResult	processDefinitionId(String processDefinitionId)
JobSearchResult	processDefinitionKey(String processDefinitionKey)
JobSearchResult	processInstanceKey(String processInstanceKey)
JobSearchResult	putCustomHeadersItem(String key, String customHeadersItem)
JobSearchResult	retries(Integer retries)
void	setCustomHeaders(Map<String,String> customHeaders)
void	setDeadline(String deadline)
void	setDeniedReason(String deniedReason)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setEndTime(String endTime)
void	setErrorCode(String errorCode)
void	setErrorMessage(String errorMessage)
void	setHasFailedWithRetriesLeft(Boolean hasFailedWithRetriesLeft)
void	setIsDenied(Boolean isDenied)
void	setJobKey(String jobKey)
void	setKind(JobKindEnum kind)
void	setListenerEventType(JobListenerEventTypeEnum listenerEventType)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setRetries(Integer retries)
void	setState(JobStateEnum state)
void	setTenantId(String tenantId)
void	setType(String type)
void	setWorker(String worker)
JobSearchResult	state(JobStateEnum state)
JobSearchResult	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
JobSearchResult	type(String type)
JobSearchResult	worker(String worker)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_CUSTOM_HEADERS

public static final String JSON_PROPERTY_CUSTOM_HEADERS

See Also:

• Constant Field Values

JSON_PROPERTY_DEADLINE

public static final String JSON_PROPERTY_DEADLINE

See Also:

• Constant Field Values

JSON_PROPERTY_DENIED_REASON

public static final String JSON_PROPERTY_DENIED_REASON

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_END_TIME

public static final String JSON_PROPERTY_END_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR_CODE

public static final String JSON_PROPERTY_ERROR_CODE

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR_MESSAGE

public static final String JSON_PROPERTY_ERROR_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_FAILED_WITH_RETRIES_LEFT

public static final String JSON_PROPERTY_HAS_FAILED_WITH_RETRIES_LEFT

See Also:

• Constant Field Values

JSON_PROPERTY_IS_DENIED

public static final String JSON_PROPERTY_IS_DENIED

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_KEY

public static final String JSON_PROPERTY_JOB_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_KIND

public static final String JSON_PROPERTY_KIND

See Also:

• Constant Field Values

JSON_PROPERTY_LISTENER_EVENT_TYPE

public static final String JSON_PROPERTY_LISTENER_EVENT_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_RETRIES

public static final String JSON_PROPERTY_RETRIES

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_WORKER

public static final String JSON_PROPERTY_WORKER

See Also:

• Constant Field Values

Constructor Details

JobSearchResult

public JobSearchResult()

Method Details

customHeaders

public JobSearchResult customHeaders(@Nullable
 Map<String,String> customHeaders)

putCustomHeadersItem

public JobSearchResult putCustomHeadersItem(String key,
 String customHeadersItem)

getCustomHeaders

@Nullable
public Map<String,String> getCustomHeaders()

A set of custom headers defined during modelling.

Returns:

customHeaders

setCustomHeaders

public void setCustomHeaders(@Nullable
 Map<String,String> customHeaders)

deadline

public JobSearchResult deadline(@Nullable
 String deadline)

getDeadline

@Nullable
public String getDeadline()

When the job can be activated.

Returns:

deadline

setDeadline

public void setDeadline(@Nullable
 String deadline)

deniedReason

public JobSearchResult deniedReason(@Nullable
 String deniedReason)

getDeniedReason

@Nullable
public String getDeniedReason()

The reason provided by the user task listener for denying the work.

Returns:

deniedReason

setDeniedReason

public void setDeniedReason(@Nullable
 String deniedReason)

elementId

public JobSearchResult elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The element ID associated with the job.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

elementInstanceKey

public JobSearchResult elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

The element instance key associated with the job.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

endTime

public JobSearchResult endTime(@Nullable
 String endTime)

getEndTime

@Nullable
public String getEndTime()

When the job ended.

Returns:

endTime

setEndTime

public void setEndTime(@Nullable
 String endTime)

errorCode

public JobSearchResult errorCode(@Nullable
 String errorCode)

getErrorCode

@Nullable
public String getErrorCode()

The error code provided for the failed job.

Returns:

errorCode

setErrorCode

public void setErrorCode(@Nullable
 String errorCode)

errorMessage

public JobSearchResult errorMessage(@Nullable
 String errorMessage)

getErrorMessage

@Nullable
public String getErrorMessage()

The error message that provides additional context for a failed job.

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(@Nullable
 String errorMessage)

hasFailedWithRetriesLeft

public JobSearchResult hasFailedWithRetriesLeft(@Nullable
 Boolean hasFailedWithRetriesLeft)

getHasFailedWithRetriesLeft

@Nullable
public Boolean getHasFailedWithRetriesLeft()

Indicates whether the job has failed with retries left.

Returns:

hasFailedWithRetriesLeft

setHasFailedWithRetriesLeft

public void setHasFailedWithRetriesLeft(@Nullable
 Boolean hasFailedWithRetriesLeft)

isDenied

public JobSearchResult isDenied(@Nullable
 Boolean isDenied)

getIsDenied

@Nullable
public Boolean getIsDenied()

Indicates whether the user task listener denies the work.

Returns:

isDenied

setIsDenied

public void setIsDenied(@Nullable
 Boolean isDenied)

jobKey

public JobSearchResult jobKey(@Nullable
 String jobKey)

getJobKey

@Nullable
public String getJobKey()

The key, a unique identifier for the job.

Returns:

jobKey

setJobKey

public void setJobKey(@Nullable
 String jobKey)

kind

public JobSearchResult kind(@Nullable
 JobKindEnum kind)

getKind

@Nullable
public JobKindEnum getKind()

Get kind

Returns:

kind

setKind

public void setKind(@Nullable
 JobKindEnum kind)

listenerEventType

public JobSearchResult listenerEventType(@Nullable
 JobListenerEventTypeEnum listenerEventType)

getListenerEventType

@Nullable
public JobListenerEventTypeEnum getListenerEventType()

Get listenerEventType

Returns:

listenerEventType

setListenerEventType

public void setListenerEventType(@Nullable
 JobListenerEventTypeEnum listenerEventType)

processDefinitionId

public JobSearchResult processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The process definition ID associated with the job.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

processDefinitionKey

public JobSearchResult processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The process definition key associated with the job.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

processInstanceKey

public JobSearchResult processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The process instance key associated with the job.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

retries

public JobSearchResult retries(@Nullable
 Integer retries)

getRetries

@Nullable
public Integer getRetries()

The amount of retries left to this job.

Returns:

retries

setRetries

public void setRetries(@Nullable
 Integer retries)

state

public JobSearchResult state(@Nullable
 JobStateEnum state)

getState

@Nullable
public JobStateEnum getState()

Get state

Returns:

state

setState

public void setState(@Nullable
 JobStateEnum state)

tenantId

public JobSearchResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

type

public JobSearchResult type(@Nullable
 String type)

getType

@Nullable
public String getType()

The type of the job.

Returns:

type

setType

public void setType(@Nullable
 String type)

worker

public JobSearchResult worker(@Nullable
 String worker)

getWorker

@Nullable
public String getWorker()

The name of the worker of this job.

Returns:

worker

setWorker

public void setWorker(@Nullable
 String worker)

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

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string