Package io.camunda.client.protocol.rest

Class JobSearchResult

java.lang.Object

io.camunda.client.protocol.rest.JobSearchResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class JobSearchResult
extends Object

JobSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
static final String	JSON_PROPERTY_CREATION_TIME
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_LAST_UPDATE_TIME
static final String	JSON_PROPERTY_LISTENER_EVENT_TYPE
static final String	JSON_PROPERTY_PRIORITY
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_ROOT_PROCESS_INSTANCE_KEY
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	businessId(String businessId)
JobSearchResult	creationTime(String creationTime)
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)
String	getBusinessId()	The business ID of the owning process instance, inherited when the job was created.
String	getCreationTime()	When the job was created.
Map<String,String>	getCustomHeaders()	A set of custom headers defined during modelling.
String	getDeadline()	If the job has been activated, when it will next be available to 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()	End date of the job.
String	getErrorCode()	The error code provided for a 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
String	getLastUpdateTime()	When the job was last updated.
JobListenerEventTypeEnum	getListenerEventType()	Get listenerEventType
Integer	getPriority()	The priority of the job.
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.
String	getRootProcessInstanceKey()	The key of the root process instance.
JobStateEnum	getState()	Get state
String	getTenantId()	The unique identifier of the tenant.
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	lastUpdateTime(String lastUpdateTime)
JobSearchResult	listenerEventType(JobListenerEventTypeEnum listenerEventType)
JobSearchResult	priority(Integer priority)
JobSearchResult	processDefinitionId(String processDefinitionId)
JobSearchResult	processDefinitionKey(String processDefinitionKey)
JobSearchResult	processInstanceKey(String processInstanceKey)
JobSearchResult	putCustomHeadersItem(String key, String customHeadersItem)
JobSearchResult	retries(Integer retries)
JobSearchResult	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setBusinessId(String businessId)
void	setCreationTime(String creationTime)
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	setLastUpdateTime(String lastUpdateTime)
void	setListenerEventType(JobListenerEventTypeEnum listenerEventType)
void	setPriority(Integer priority)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setRetries(Integer retries)
void	setRootProcessInstanceKey(String rootProcessInstanceKey)
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()
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_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

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

JSON_PROPERTY_CREATION_TIME

public static final String JSON_PROPERTY_CREATION_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_UPDATE_TIME

public static final String JSON_PROPERTY_LAST_UPDATE_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_PRIORITY

public static final String JSON_PROPERTY_PRIORITY

See Also:

• Constant Field Values

Constructor Details

JobSearchResult

public JobSearchResult()

Method Details

customHeaders

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

putCustomHeadersItem

public JobSearchResult putCustomHeadersItem(String key,
 String customHeadersItem)

getCustomHeaders

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

A set of custom headers defined during modelling.

Returns:

customHeaders

setCustomHeaders

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

deadline

public JobSearchResult deadline(@Nullable
 String deadline)

getDeadline

@Nullable
public String getDeadline()

If the job has been activated, when it will next be available to 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. May be missing on job failure.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

elementInstanceKey

public JobSearchResult elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The element instance key associated with the job.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

endTime

public JobSearchResult endTime(@Nullable
 String endTime)

getEndTime

@Nullable
public String getEndTime()

End date of the job. This is `null` if the job is not in an end state yet.

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 a 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(@Nonnull
 Boolean hasFailedWithRetriesLeft)

getHasFailedWithRetriesLeft

@Nonnull
public Boolean getHasFailedWithRetriesLeft()

Indicates whether the job has failed with retries left.

Returns:

hasFailedWithRetriesLeft

setHasFailedWithRetriesLeft

public void setHasFailedWithRetriesLeft(@Nonnull
 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(@Nonnull
 String jobKey)

getJobKey

@Nonnull
public String getJobKey()

The key, a unique identifier for the job.

Returns:

jobKey

setJobKey

public void setJobKey(@Nonnull
 String jobKey)

kind

public JobSearchResult kind(@Nonnull
 JobKindEnum kind)

getKind

@Nonnull
public JobKindEnum getKind()

Get kind

Returns:

kind

setKind

public void setKind(@Nonnull
 JobKindEnum kind)

listenerEventType

public JobSearchResult listenerEventType(@Nonnull
 JobListenerEventTypeEnum listenerEventType)

getListenerEventType

@Nonnull
public JobListenerEventTypeEnum getListenerEventType()

Get listenerEventType

Returns:

listenerEventType

setListenerEventType

public void setListenerEventType(@Nonnull
 JobListenerEventTypeEnum listenerEventType)

processDefinitionId

public JobSearchResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

The process definition ID associated with the job.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 String processDefinitionId)

processDefinitionKey

public JobSearchResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The process definition key associated with the job.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 String processDefinitionKey)

processInstanceKey

public JobSearchResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The process instance key associated with the job.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

rootProcessInstanceKey

public JobSearchResult rootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

getRootProcessInstanceKey

@Nullable
public String getRootProcessInstanceKey()

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

Returns:

rootProcessInstanceKey

setRootProcessInstanceKey

public void setRootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

businessId

public JobSearchResult businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

The business ID of the owning process instance, inherited when the job was created. This is `null` for jobs created before version 8.10 and for jobs whose owning process instance has no business ID.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

retries

public JobSearchResult retries(@Nonnull
 Integer retries)

getRetries

@Nonnull
public Integer getRetries()

The amount of retries left to this job.

Returns:

retries

setRetries

public void setRetries(@Nonnull
 Integer retries)

state

public JobSearchResult state(@Nonnull
 JobStateEnum state)

getState

@Nonnull
public JobStateEnum getState()

Get state

Returns:

state

setState

public void setState(@Nonnull
 JobStateEnum state)

tenantId

public JobSearchResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The unique identifier of the tenant.

Returns:

tenantId

setTenantId

public void setTenantId(@Nonnull
 String tenantId)

type

public JobSearchResult type(@Nonnull
 String type)

getType

@Nonnull
public String getType()

The type of the job.

Returns:

type

setType

public void setType(@Nonnull
 String type)

worker

public JobSearchResult worker(@Nonnull
 String worker)

getWorker

@Nonnull
public String getWorker()

The name of the worker of this job.

Returns:

worker

setWorker

public void setWorker(@Nonnull
 String worker)

creationTime

public JobSearchResult creationTime(@Nullable
 String creationTime)

getCreationTime

@Nullable
public String getCreationTime()

When the job was created. Field is present for jobs created after 8.9.

Returns:

creationTime

setCreationTime

public void setCreationTime(@Nullable
 String creationTime)

lastUpdateTime

public JobSearchResult lastUpdateTime(@Nullable
 String lastUpdateTime)

getLastUpdateTime

@Nullable
public String getLastUpdateTime()

When the job was last updated. Field is present for jobs created after 8.9.

Returns:

lastUpdateTime

setLastUpdateTime

public void setLastUpdateTime(@Nullable
 String lastUpdateTime)

priority

public JobSearchResult priority(@Nonnull
 Integer priority)

getPriority

@Nonnull
public Integer getPriority()

The priority of the job. Higher values indicate higher priority. Jobs created before 8.10 have no stored priority; they appear last when sorting by this field and are excluded when filtering by this field. The API returns 0 for such jobs.

Returns:

priority

setPriority

public void setPriority(@Nonnull
 Integer priority)

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