Package io.camunda.client.protocol.rest

Class JobFilter

java.lang.Object

io.camunda.client.protocol.rest.JobFilter

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

Job search filter.

Field Summary

Fields

Modifier and Type	Field	Description
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
JobFilter()

Method Summary

Modifier and Type	Method	Description
JobFilter	deadline(DateTimeFilterProperty deadline)
JobFilter	deniedReason(StringFilterProperty deniedReason)
JobFilter	elementId(StringFilterProperty elementId)
JobFilter	elementInstanceKey(BasicStringFilterProperty elementInstanceKey)
JobFilter	endTime(DateTimeFilterProperty endTime)
boolean	equals(Object o)
JobFilter	errorCode(StringFilterProperty errorCode)
JobFilter	errorMessage(StringFilterProperty errorMessage)
DateTimeFilterProperty	getDeadline()	When the job can be activated.
StringFilterProperty	getDeniedReason()	The reason provided by the user task listener for denying the work.
StringFilterProperty	getElementId()	The element ID associated with the job.
BasicStringFilterProperty	getElementInstanceKey()	The element instance key associated with the job.
DateTimeFilterProperty	getEndTime()	When the job ended.
StringFilterProperty	getErrorCode()	The error code provided for the failed job.
StringFilterProperty	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.
BasicStringFilterProperty	getJobKey()	The key, a unique identifier for the job.
JobKindFilterProperty	getKind()	The kind of the job.
JobListenerEventTypeFilterProperty	getListenerEventType()	The listener event type of the job.
StringFilterProperty	getProcessDefinitionId()	The process definition ID associated with the job.
BasicStringFilterProperty	getProcessDefinitionKey()	The process definition key associated with the job.
BasicStringFilterProperty	getProcessInstanceKey()	The process instance key associated with the job.
IntegerFilterProperty	getRetries()	The number of retries left.
JobStateFilterProperty	getState()	The state of the job.
StringFilterProperty	getTenantId()	The tenant ID.
StringFilterProperty	getType()	The type of the job.
StringFilterProperty	getWorker()	The name of the worker for this job.
JobFilter	hasFailedWithRetriesLeft(Boolean hasFailedWithRetriesLeft)
int	hashCode()
JobFilter	isDenied(Boolean isDenied)
JobFilter	jobKey(BasicStringFilterProperty jobKey)
JobFilter	kind(JobKindFilterProperty kind)
JobFilter	listenerEventType(JobListenerEventTypeFilterProperty listenerEventType)
JobFilter	processDefinitionId(StringFilterProperty processDefinitionId)
JobFilter	processDefinitionKey(BasicStringFilterProperty processDefinitionKey)
JobFilter	processInstanceKey(BasicStringFilterProperty processInstanceKey)
JobFilter	retries(IntegerFilterProperty retries)
void	setDeadline(DateTimeFilterProperty deadline)
void	setDeniedReason(StringFilterProperty deniedReason)
void	setElementId(StringFilterProperty elementId)
void	setElementInstanceKey(BasicStringFilterProperty elementInstanceKey)
void	setEndTime(DateTimeFilterProperty endTime)
void	setErrorCode(StringFilterProperty errorCode)
void	setErrorMessage(StringFilterProperty errorMessage)
void	setHasFailedWithRetriesLeft(Boolean hasFailedWithRetriesLeft)
void	setIsDenied(Boolean isDenied)
void	setJobKey(BasicStringFilterProperty jobKey)
void	setKind(JobKindFilterProperty kind)
void	setListenerEventType(JobListenerEventTypeFilterProperty listenerEventType)
void	setProcessDefinitionId(StringFilterProperty processDefinitionId)
void	setProcessDefinitionKey(BasicStringFilterProperty processDefinitionKey)
void	setProcessInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setRetries(IntegerFilterProperty retries)
void	setState(JobStateFilterProperty state)
void	setTenantId(StringFilterProperty tenantId)
void	setType(StringFilterProperty type)
void	setWorker(StringFilterProperty worker)
JobFilter	state(JobStateFilterProperty state)
JobFilter	tenantId(StringFilterProperty tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
JobFilter	type(StringFilterProperty type)
JobFilter	worker(StringFilterProperty worker)

Methods inherited from class java.lang.Object

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

Field Details

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

JobFilter

public JobFilter()

Method Details

deadline

public JobFilter deadline(@Nullable
 DateTimeFilterProperty deadline)

getDeadline

@Nullable
public DateTimeFilterProperty getDeadline()

When the job can be activated.

Returns:

deadline

setDeadline

public void setDeadline(@Nullable
 DateTimeFilterProperty deadline)

deniedReason

public JobFilter deniedReason(@Nullable
 StringFilterProperty deniedReason)

getDeniedReason

@Nullable
public StringFilterProperty getDeniedReason()

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

Returns:

deniedReason

setDeniedReason

public void setDeniedReason(@Nullable
 StringFilterProperty deniedReason)

elementId

public JobFilter elementId(@Nullable
 StringFilterProperty elementId)

getElementId

@Nullable
public StringFilterProperty getElementId()

The element ID associated with the job.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 StringFilterProperty elementId)

elementInstanceKey

public JobFilter elementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

getElementInstanceKey

@Nullable
public BasicStringFilterProperty getElementInstanceKey()

The element instance key associated with the job.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

endTime

public JobFilter endTime(@Nullable
 DateTimeFilterProperty endTime)

getEndTime

@Nullable
public DateTimeFilterProperty getEndTime()

When the job ended.

Returns:

endTime

setEndTime

public void setEndTime(@Nullable
 DateTimeFilterProperty endTime)

errorCode

public JobFilter errorCode(@Nullable
 StringFilterProperty errorCode)

getErrorCode

@Nullable
public StringFilterProperty getErrorCode()

The error code provided for the failed job.

Returns:

errorCode

setErrorCode

public void setErrorCode(@Nullable
 StringFilterProperty errorCode)

errorMessage

public JobFilter errorMessage(@Nullable
 StringFilterProperty errorMessage)

getErrorMessage

@Nullable
public StringFilterProperty getErrorMessage()

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

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(@Nullable
 StringFilterProperty errorMessage)

hasFailedWithRetriesLeft

public JobFilter 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 JobFilter 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 JobFilter jobKey(@Nullable
 BasicStringFilterProperty jobKey)

getJobKey

@Nullable
public BasicStringFilterProperty getJobKey()

The key, a unique identifier for the job.

Returns:

jobKey

setJobKey

public void setJobKey(@Nullable
 BasicStringFilterProperty jobKey)

kind

public JobFilter kind(@Nullable
 JobKindFilterProperty kind)

getKind

@Nullable
public JobKindFilterProperty getKind()

The kind of the job.

Returns:

kind

setKind

public void setKind(@Nullable
 JobKindFilterProperty kind)

listenerEventType

public JobFilter listenerEventType(@Nullable
 JobListenerEventTypeFilterProperty listenerEventType)

getListenerEventType

@Nullable
public JobListenerEventTypeFilterProperty getListenerEventType()

The listener event type of the job.

Returns:

listenerEventType

setListenerEventType

public void setListenerEventType(@Nullable
 JobListenerEventTypeFilterProperty listenerEventType)

processDefinitionId

public JobFilter processDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

getProcessDefinitionId

@Nullable
public StringFilterProperty getProcessDefinitionId()

The process definition ID associated with the job.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

processDefinitionKey

public JobFilter processDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

getProcessDefinitionKey

@Nullable
public BasicStringFilterProperty getProcessDefinitionKey()

The process definition key associated with the job.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

processInstanceKey

public JobFilter processInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

getProcessInstanceKey

@Nullable
public BasicStringFilterProperty getProcessInstanceKey()

The process instance key associated with the job.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

retries

public JobFilter retries(@Nullable
 IntegerFilterProperty retries)

getRetries

@Nullable
public IntegerFilterProperty getRetries()

The number of retries left.

Returns:

retries

setRetries

public void setRetries(@Nullable
 IntegerFilterProperty retries)

state

public JobFilter state(@Nullable
 JobStateFilterProperty state)

getState

@Nullable
public JobStateFilterProperty getState()

The state of the job.

Returns:

state

setState

public void setState(@Nullable
 JobStateFilterProperty state)

tenantId

public JobFilter tenantId(@Nullable
 StringFilterProperty tenantId)

getTenantId

@Nullable
public StringFilterProperty getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 StringFilterProperty tenantId)

type

public JobFilter type(@Nullable
 StringFilterProperty type)

getType

@Nullable
public StringFilterProperty getType()

The type of the job.

Returns:

type

setType

public void setType(@Nullable
 StringFilterProperty type)

worker

public JobFilter worker(@Nullable
 StringFilterProperty worker)

getWorker

@Nullable
public StringFilterProperty getWorker()

The name of the worker for this job.

Returns:

worker

setWorker

public void setWorker(@Nullable
 StringFilterProperty 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