org.openapitools.client.model

Class ExternalTaskQueryDto

java.lang.Object

org.openapitools.client.model.ExternalTaskQueryDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class ExternalTaskQueryDto
extends Object

A JSON object with the following properties:

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACTIVE
static String	SERIALIZED_NAME_ACTIVITY_ID
static String	SERIALIZED_NAME_ACTIVITY_ID_IN
static String	SERIALIZED_NAME_EXECUTION_ID
static String	SERIALIZED_NAME_EXTERNAL_TASK_ID
static String	SERIALIZED_NAME_EXTERNAL_TASK_ID_IN
static String	SERIALIZED_NAME_LOCK_EXPIRATION_AFTER
static String	SERIALIZED_NAME_LOCK_EXPIRATION_BEFORE
static String	SERIALIZED_NAME_LOCKED
static String	SERIALIZED_NAME_NO_RETRIES_LEFT
static String	SERIALIZED_NAME_NOT_LOCKED
static String	SERIALIZED_NAME_PRIORITY_HIGHER_THAN_OR_EQUALS
static String	SERIALIZED_NAME_PRIORITY_LOWER_THAN_OR_EQUALS
static String	SERIALIZED_NAME_PROCESS_DEFINITION_ID
static String	SERIALIZED_NAME_PROCESS_INSTANCE_ID
static String	SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN
static String	SERIALIZED_NAME_SORTING
static String	SERIALIZED_NAME_SUSPENDED
static String	SERIALIZED_NAME_TENANT_ID_IN
static String	SERIALIZED_NAME_TOPIC_NAME
static String	SERIALIZED_NAME_WITH_RETRIES_LEFT
static String	SERIALIZED_NAME_WORKER_ID

Constructor Summary

Constructors

Constructor and Description
ExternalTaskQueryDto()

Method Summary

Modifier and Type	Method and Description
ExternalTaskQueryDto	active(Boolean active)
ExternalTaskQueryDto	activityId(String activityId)
ExternalTaskQueryDto	activityIdIn(List<String> activityIdIn)
ExternalTaskQueryDto	addActivityIdInItem(String activityIdInItem)
ExternalTaskQueryDto	addExternalTaskIdInItem(String externalTaskIdInItem)
ExternalTaskQueryDto	addProcessInstanceIdInItem(String processInstanceIdInItem)
ExternalTaskQueryDto	addSortingItem(ExternalTaskQueryDtoSorting sortingItem)
ExternalTaskQueryDto	addTenantIdInItem(String tenantIdInItem)
boolean	equals(Object o)
ExternalTaskQueryDto	executionId(String executionId)
ExternalTaskQueryDto	externalTaskId(String externalTaskId)
ExternalTaskQueryDto	externalTaskIdIn(List<String> externalTaskIdIn)
Boolean	getActive() Only include active tasks.
String	getActivityId() Filter by the id of the activity that an external task is created for.
List<String>	getActivityIdIn() Filter by the comma-separated list of ids of the activities that an external task is created for.
String	getExecutionId() Filter by the id of the execution that an external task belongs to.
String	getExternalTaskId() Filter by an external task's id.
List<String>	getExternalTaskIdIn() Filter by the comma-separated list of external task ids.
Boolean	getLocked() Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired).
Date	getLockExpirationAfter() Restrict to external tasks that have a lock that expires after a given date.
Date	getLockExpirationBefore() Restrict to external tasks that have a lock that expires before a given date.
Boolean	getNoRetriesLeft() Only include external tasks that have 0 retries.
Boolean	getNotLocked() Only include external tasks that are currently not locked (i.e., they have no lock or it has expired).
Long	getPriorityHigherThanOrEquals() Only include jobs with a priority higher than or equal to the given value.
Long	getPriorityLowerThanOrEquals() Only include jobs with a priority lower than or equal to the given value.
String	getProcessDefinitionId() Filter by the id of the process definition that an external task belongs to.
String	getProcessInstanceId() Filter by the id of the process instance that an external task belongs to.
List<String>	getProcessInstanceIdIn() Filter by a comma-separated list of process instance ids that an external task may belong to.
List<ExternalTaskQueryDtoSorting>	getSorting() A JSON array of criteria to sort the result by.
Boolean	getSuspended() Only include suspended tasks.
List<String>	getTenantIdIn() Filter by a comma-separated list of tenant ids.
String	getTopicName() Filter by an external task topic.
Boolean	getWithRetriesLeft() Only include external tasks that have a positive (&gt; 0) number of retries (or `null`).
String	getWorkerId() Filter by the id of the worker that the task was most recently locked by.
int	hashCode()
ExternalTaskQueryDto	locked(Boolean locked)
ExternalTaskQueryDto	lockExpirationAfter(Date lockExpirationAfter)
ExternalTaskQueryDto	lockExpirationBefore(Date lockExpirationBefore)
ExternalTaskQueryDto	noRetriesLeft(Boolean noRetriesLeft)
ExternalTaskQueryDto	notLocked(Boolean notLocked)
ExternalTaskQueryDto	priorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
ExternalTaskQueryDto	priorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
ExternalTaskQueryDto	processDefinitionId(String processDefinitionId)
ExternalTaskQueryDto	processInstanceId(String processInstanceId)
ExternalTaskQueryDto	processInstanceIdIn(List<String> processInstanceIdIn)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setActivityIdIn(List<String> activityIdIn)
void	setExecutionId(String executionId)
void	setExternalTaskId(String externalTaskId)
void	setExternalTaskIdIn(List<String> externalTaskIdIn)
void	setLocked(Boolean locked)
void	setLockExpirationAfter(Date lockExpirationAfter)
void	setLockExpirationBefore(Date lockExpirationBefore)
void	setNoRetriesLeft(Boolean noRetriesLeft)
void	setNotLocked(Boolean notLocked)
void	setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
void	setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceId(String processInstanceId)
void	setProcessInstanceIdIn(List<String> processInstanceIdIn)
void	setSorting(List<ExternalTaskQueryDtoSorting> sorting)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIdIn)
void	setTopicName(String topicName)
void	setWithRetriesLeft(Boolean withRetriesLeft)
void	setWorkerId(String workerId)
ExternalTaskQueryDto	sorting(List<ExternalTaskQueryDtoSorting> sorting)
ExternalTaskQueryDto	suspended(Boolean suspended)
ExternalTaskQueryDto	tenantIdIn(List<String> tenantIdIn)
ExternalTaskQueryDto	topicName(String topicName)
String	toString()
ExternalTaskQueryDto	withRetriesLeft(Boolean withRetriesLeft)
ExternalTaskQueryDto	workerId(String workerId)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EXTERNAL_TASK_ID

public static final String SERIALIZED_NAME_EXTERNAL_TASK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_EXTERNAL_TASK_ID_IN

public static final String SERIALIZED_NAME_EXTERNAL_TASK_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_TOPIC_NAME

public static final String SERIALIZED_NAME_TOPIC_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_WORKER_ID

public static final String SERIALIZED_NAME_WORKER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_LOCKED

public static final String SERIALIZED_NAME_LOCKED

See Also:

Constant Field Values

SERIALIZED_NAME_NOT_LOCKED

public static final String SERIALIZED_NAME_NOT_LOCKED

See Also:

Constant Field Values

SERIALIZED_NAME_WITH_RETRIES_LEFT

public static final String SERIALIZED_NAME_WITH_RETRIES_LEFT

See Also:

Constant Field Values

SERIALIZED_NAME_NO_RETRIES_LEFT

public static final String SERIALIZED_NAME_NO_RETRIES_LEFT

See Also:

Constant Field Values

SERIALIZED_NAME_LOCK_EXPIRATION_AFTER

public static final String SERIALIZED_NAME_LOCK_EXPIRATION_AFTER

See Also:

Constant Field Values

SERIALIZED_NAME_LOCK_EXPIRATION_BEFORE

public static final String SERIALIZED_NAME_LOCK_EXPIRATION_BEFORE

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_ID

public static final String SERIALIZED_NAME_ACTIVITY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_ID_IN

public static final String SERIALIZED_NAME_ACTIVITY_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_EXECUTION_ID

public static final String SERIALIZED_NAME_EXECUTION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_INSTANCE_ID

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

Constant Field Values

SERIALIZED_NAME_SUSPENDED

public static final String SERIALIZED_NAME_SUSPENDED

See Also:

Constant Field Values

SERIALIZED_NAME_PRIORITY_HIGHER_THAN_OR_EQUALS

public static final String SERIALIZED_NAME_PRIORITY_HIGHER_THAN_OR_EQUALS

See Also:

Constant Field Values

SERIALIZED_NAME_PRIORITY_LOWER_THAN_OR_EQUALS

public static final String SERIALIZED_NAME_PRIORITY_LOWER_THAN_OR_EQUALS

See Also:

Constant Field Values

SERIALIZED_NAME_SORTING

public static final String SERIALIZED_NAME_SORTING

See Also:

Constant Field Values

Constructor Detail

ExternalTaskQueryDto

public ExternalTaskQueryDto()

Method Detail

externalTaskId

public ExternalTaskQueryDto externalTaskId(String externalTaskId)

getExternalTaskId

@Nullable
public String getExternalTaskId()

Filter by an external task's id.

Returns:

externalTaskId

setExternalTaskId

public void setExternalTaskId(String externalTaskId)

externalTaskIdIn

public ExternalTaskQueryDto externalTaskIdIn(List<String> externalTaskIdIn)

addExternalTaskIdInItem

public ExternalTaskQueryDto addExternalTaskIdInItem(String externalTaskIdInItem)

getExternalTaskIdIn

@Nullable
public List<String> getExternalTaskIdIn()

Filter by the comma-separated list of external task ids.

Returns:

externalTaskIdIn

setExternalTaskIdIn

public void setExternalTaskIdIn(List<String> externalTaskIdIn)

topicName

public ExternalTaskQueryDto topicName(String topicName)

getTopicName

@Nullable
public String getTopicName()

Filter by an external task topic.

Returns:

topicName

setTopicName

public void setTopicName(String topicName)

workerId

public ExternalTaskQueryDto workerId(String workerId)

getWorkerId

@Nullable
public String getWorkerId()

Filter by the id of the worker that the task was most recently locked by.

Returns:

workerId

setWorkerId

public void setWorkerId(String workerId)

locked

public ExternalTaskQueryDto locked(Boolean locked)

getLocked

@Nullable
public Boolean getLocked()

Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task.

Returns:

locked

setLocked

public void setLocked(Boolean locked)

notLocked

public ExternalTaskQueryDto notLocked(Boolean notLocked)

getNotLocked

@Nullable
public Boolean getNotLocked()

Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task.

Returns:

notLocked

setNotLocked

public void setNotLocked(Boolean notLocked)

withRetriesLeft

public ExternalTaskQueryDto withRetriesLeft(Boolean withRetriesLeft)

getWithRetriesLeft

@Nullable
public Boolean getWithRetriesLeft()

Only include external tasks that have a positive (> 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task.

Returns:

withRetriesLeft

setWithRetriesLeft

public void setWithRetriesLeft(Boolean withRetriesLeft)

noRetriesLeft

public ExternalTaskQueryDto noRetriesLeft(Boolean noRetriesLeft)

getNoRetriesLeft

@Nullable
public Boolean getNoRetriesLeft()

Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task.

Returns:

noRetriesLeft

setNoRetriesLeft

public void setNoRetriesLeft(Boolean noRetriesLeft)

lockExpirationAfter

public ExternalTaskQueryDto lockExpirationAfter(Date lockExpirationAfter)

getLockExpirationAfter

@Nullable
public Date getLockExpirationAfter()

Restrict to external tasks that have a lock that expires after a given date. By [default](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

lockExpirationAfter

setLockExpirationAfter

public void setLockExpirationAfter(Date lockExpirationAfter)

lockExpirationBefore

public ExternalTaskQueryDto lockExpirationBefore(Date lockExpirationBefore)

getLockExpirationBefore

@Nullable
public Date getLockExpirationBefore()

Restrict to external tasks that have a lock that expires before a given date. By [default](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.

Returns:

lockExpirationBefore

setLockExpirationBefore

public void setLockExpirationBefore(Date lockExpirationBefore)

activityId

public ExternalTaskQueryDto activityId(String activityId)

getActivityId

@Nullable
public String getActivityId()

Filter by the id of the activity that an external task is created for.

Returns:

activityId

setActivityId

public void setActivityId(String activityId)

activityIdIn

public ExternalTaskQueryDto activityIdIn(List<String> activityIdIn)

addActivityIdInItem

public ExternalTaskQueryDto addActivityIdInItem(String activityIdInItem)

getActivityIdIn

@Nullable
public List<String> getActivityIdIn()

Filter by the comma-separated list of ids of the activities that an external task is created for.

Returns:

activityIdIn

setActivityIdIn

public void setActivityIdIn(List<String> activityIdIn)

executionId

public ExternalTaskQueryDto executionId(String executionId)

getExecutionId

@Nullable
public String getExecutionId()

Filter by the id of the execution that an external task belongs to.

Returns:

executionId

setExecutionId

public void setExecutionId(String executionId)

processInstanceId

public ExternalTaskQueryDto processInstanceId(String processInstanceId)

getProcessInstanceId

@Nullable
public String getProcessInstanceId()

Filter by the id of the process instance that an external task belongs to.

Returns:

processInstanceId

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

processInstanceIdIn

public ExternalTaskQueryDto processInstanceIdIn(List<String> processInstanceIdIn)

addProcessInstanceIdInItem

public ExternalTaskQueryDto addProcessInstanceIdInItem(String processInstanceIdInItem)

getProcessInstanceIdIn

@Nullable
public List<String> getProcessInstanceIdIn()

Filter by a comma-separated list of process instance ids that an external task may belong to.

Returns:

processInstanceIdIn

setProcessInstanceIdIn

public void setProcessInstanceIdIn(List<String> processInstanceIdIn)

processDefinitionId

public ExternalTaskQueryDto processDefinitionId(String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

Filter by the id of the process definition that an external task belongs to.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

tenantIdIn

public ExternalTaskQueryDto tenantIdIn(List<String> tenantIdIn)

addTenantIdInItem

public ExternalTaskQueryDto addTenantIdInItem(String tenantIdInItem)

getTenantIdIn

@Nullable
public List<String> getTenantIdIn()

Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids.

Returns:

tenantIdIn

setTenantIdIn

public void setTenantIdIn(List<String> tenantIdIn)

active

public ExternalTaskQueryDto active(Boolean active)

getActive

@Nullable
public Boolean getActive()

Only include active tasks. Value may only be `true`, as `false` matches any external task.

Returns:

active

setActive

public void setActive(Boolean active)

suspended

public ExternalTaskQueryDto suspended(Boolean suspended)

getSuspended

@Nullable
public Boolean getSuspended()

Only include suspended tasks. Value may only be `true`, as `false` matches any external task.

Returns:

suspended

setSuspended

public void setSuspended(Boolean suspended)

priorityHigherThanOrEquals

public ExternalTaskQueryDto priorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

getPriorityHigherThanOrEquals

@Nullable
public Long getPriorityHigherThanOrEquals()

Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value.

Returns:

priorityHigherThanOrEquals

setPriorityHigherThanOrEquals

public void setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

priorityLowerThanOrEquals

public ExternalTaskQueryDto priorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

getPriorityLowerThanOrEquals

@Nullable
public Long getPriorityLowerThanOrEquals()

Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value.

Returns:

priorityLowerThanOrEquals

setPriorityLowerThanOrEquals

public void setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

sorting

public ExternalTaskQueryDto sorting(List<ExternalTaskQueryDtoSorting> sorting)

addSortingItem

public ExternalTaskQueryDto addSortingItem(ExternalTaskQueryDtoSorting sortingItem)

getSorting

@Nullable
public List<ExternalTaskQueryDtoSorting> getSorting()

A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. The ordering objects have the following properties: **Note:** The `sorting` properties will not be applied to the External Task count query.

Returns:

sorting

setSorting

public void setSorting(List<ExternalTaskQueryDtoSorting> sorting)

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