org.openapitools.client.model

Class JobQueryDto

java.lang.Object

org.openapitools.client.model.JobQueryDto

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

A Job instance query which defines a list of Job instances

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACTIVE
static String	SERIALIZED_NAME_ACTIVITY_ID
static String	SERIALIZED_NAME_CREATE_TIMES
static String	SERIALIZED_NAME_DUE_DATES
static String	SERIALIZED_NAME_EXCEPTION_MESSAGE
static String	SERIALIZED_NAME_EXECUTABLE
static String	SERIALIZED_NAME_EXECUTION_ID
static String	SERIALIZED_NAME_FAILED_ACTIVITY_ID
static String	SERIALIZED_NAME_INCLUDE_JOBS_WITHOUT_TENANT_ID
static String	SERIALIZED_NAME_JOB_DEFINITION_ID
static String	SERIALIZED_NAME_JOB_ID
static String	SERIALIZED_NAME_JOB_IDS
static String	SERIALIZED_NAME_MESSAGES
static String	SERIALIZED_NAME_NO_RETRIES_LEFT
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_DEFINITION_KEY
static String	SERIALIZED_NAME_PROCESS_INSTANCE_ID
static String	SERIALIZED_NAME_PROCESS_INSTANCE_IDS
static String	SERIALIZED_NAME_SORTING
static String	SERIALIZED_NAME_SUSPENDED
static String	SERIALIZED_NAME_TENANT_ID_IN
static String	SERIALIZED_NAME_TIMERS
static String	SERIALIZED_NAME_WITH_EXCEPTION
static String	SERIALIZED_NAME_WITH_RETRIES_LEFT
static String	SERIALIZED_NAME_WITHOUT_TENANT_ID

Constructor Summary

Constructors

Constructor and Description
JobQueryDto()

Method Summary

Modifier and Type	Method and Description
JobQueryDto	active(Boolean active)
JobQueryDto	activityId(String activityId)
JobQueryDto	addCreateTimesItem(JobConditionQueryParameterDto createTimesItem)
JobQueryDto	addDueDatesItem(JobConditionQueryParameterDto dueDatesItem)
JobQueryDto	addJobIdsItem(String jobIdsItem)
JobQueryDto	addProcessInstanceIdsItem(String processInstanceIdsItem)
JobQueryDto	addSortingItem(JobQueryDtoSorting sortingItem)
JobQueryDto	addTenantIdInItem(String tenantIdInItem)
JobQueryDto	createTimes(List<JobConditionQueryParameterDto> createTimes)
JobQueryDto	dueDates(List<JobConditionQueryParameterDto> dueDates)
boolean	equals(Object o)
JobQueryDto	exceptionMessage(String exceptionMessage)
JobQueryDto	executable(Boolean executable)
JobQueryDto	executionId(String executionId)
JobQueryDto	failedActivityId(String failedActivityId)
Boolean	getActive() Only include active jobs.
String	getActivityId() Only select jobs which exist for an activity with the given id.
List<JobConditionQueryParameterDto>	getCreateTimes() Only select jobs created before or after the given date.
List<JobConditionQueryParameterDto>	getDueDates() Only select jobs where the due date is lower or higher than the given date.
String	getExceptionMessage() Only select jobs that failed due to an exception with the given message.
Boolean	getExecutable() Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past.
String	getExecutionId() Only select jobs which exist for the given execution.
String	getFailedActivityId() Only select jobs that failed due to an exception at an activity with the given id.
Boolean	getIncludeJobsWithoutTenantId() Include jobs which belong to no tenant.
String	getJobDefinitionId() Only select jobs which exist for the given job definition.
String	getJobId() Filter by job id.
List<String>	getJobIds() Filter by a list of job ids.
Boolean	getMessages() Only select jobs that are messages.
Boolean	getNoRetriesLeft() Only select jobs which have no retries left.
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 the jobs run on.
String	getProcessDefinitionKey() Filter by the key of the process definition the jobs run on.
String	getProcessInstanceId() Only select jobs which exist for the given process instance.
List<String>	getProcessInstanceIds() Only select jobs which exist for the given list of process instance ids.
List<JobQueryDtoSorting>	getSorting() An array of criteria to sort the result by.
Boolean	getSuspended() Only include suspended jobs.
List<String>	getTenantIdIn() Only include jobs which belong to one of the passed tenant ids.
Boolean	getTimers() Only select jobs that are timers.
Boolean	getWithException() Only select jobs that failed due to an exception.
Boolean	getWithoutTenantId() Only include jobs which belong to no tenant.
Boolean	getWithRetriesLeft() Only select jobs which have retries left.
int	hashCode()
JobQueryDto	includeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)
JobQueryDto	jobDefinitionId(String jobDefinitionId)
JobQueryDto	jobId(String jobId)
JobQueryDto	jobIds(List<String> jobIds)
JobQueryDto	messages(Boolean messages)
JobQueryDto	noRetriesLeft(Boolean noRetriesLeft)
JobQueryDto	priorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
JobQueryDto	priorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
JobQueryDto	processDefinitionId(String processDefinitionId)
JobQueryDto	processDefinitionKey(String processDefinitionKey)
JobQueryDto	processInstanceId(String processInstanceId)
JobQueryDto	processInstanceIds(List<String> processInstanceIds)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setCreateTimes(List<JobConditionQueryParameterDto> createTimes)
void	setDueDates(List<JobConditionQueryParameterDto> dueDates)
void	setExceptionMessage(String exceptionMessage)
void	setExecutable(Boolean executable)
void	setExecutionId(String executionId)
void	setFailedActivityId(String failedActivityId)
void	setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)
void	setJobDefinitionId(String jobDefinitionId)
void	setJobId(String jobId)
void	setJobIds(List<String> jobIds)
void	setMessages(Boolean messages)
void	setNoRetriesLeft(Boolean noRetriesLeft)
void	setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
void	setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceId(String processInstanceId)
void	setProcessInstanceIds(List<String> processInstanceIds)
void	setSorting(List<JobQueryDtoSorting> sorting)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIdIn)
void	setTimers(Boolean timers)
void	setWithException(Boolean withException)
void	setWithoutTenantId(Boolean withoutTenantId)
void	setWithRetriesLeft(Boolean withRetriesLeft)
JobQueryDto	sorting(List<JobQueryDtoSorting> sorting)
JobQueryDto	suspended(Boolean suspended)
JobQueryDto	tenantIdIn(List<String> tenantIdIn)
JobQueryDto	timers(Boolean timers)
String	toString()
JobQueryDto	withException(Boolean withException)
JobQueryDto	withoutTenantId(Boolean withoutTenantId)
JobQueryDto	withRetriesLeft(Boolean withRetriesLeft)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_JOB_ID

public static final String SERIALIZED_NAME_JOB_ID

See Also:

Constant Field Values

SERIALIZED_NAME_JOB_IDS

public static final String SERIALIZED_NAME_JOB_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_JOB_DEFINITION_ID

public static final String SERIALIZED_NAME_JOB_DEFINITION_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_IDS

public static final String SERIALIZED_NAME_PROCESS_INSTANCE_IDS

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_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_ID

public static final String SERIALIZED_NAME_ACTIVITY_ID

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_EXECUTABLE

public static final String SERIALIZED_NAME_EXECUTABLE

See Also:

Constant Field Values

SERIALIZED_NAME_TIMERS

public static final String SERIALIZED_NAME_TIMERS

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGES

public static final String SERIALIZED_NAME_MESSAGES

See Also:

Constant Field Values

SERIALIZED_NAME_DUE_DATES

public static final String SERIALIZED_NAME_DUE_DATES

See Also:

Constant Field Values

SERIALIZED_NAME_CREATE_TIMES

public static final String SERIALIZED_NAME_CREATE_TIMES

See Also:

Constant Field Values

SERIALIZED_NAME_WITH_EXCEPTION

public static final String SERIALIZED_NAME_WITH_EXCEPTION

See Also:

Constant Field Values

SERIALIZED_NAME_EXCEPTION_MESSAGE

public static final String SERIALIZED_NAME_EXCEPTION_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_FAILED_ACTIVITY_ID

public static final String SERIALIZED_NAME_FAILED_ACTIVITY_ID

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_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_LOWER_THAN_OR_EQUALS

public static final String SERIALIZED_NAME_PRIORITY_LOWER_THAN_OR_EQUALS

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_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_JOBS_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_INCLUDE_JOBS_WITHOUT_TENANT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SORTING

public static final String SERIALIZED_NAME_SORTING

See Also:

Constant Field Values

Constructor Detail

JobQueryDto

public JobQueryDto()

Method Detail

jobId

public JobQueryDto jobId(String jobId)

getJobId

@Nullable
public String getJobId()

Filter by job id.

Returns:

jobId

setJobId

public void setJobId(String jobId)

jobIds

public JobQueryDto jobIds(List<String> jobIds)

addJobIdsItem

public JobQueryDto addJobIdsItem(String jobIdsItem)

getJobIds

@Nullable
public List<String> getJobIds()

Filter by a list of job ids.

Returns:

jobIds

setJobIds

public void setJobIds(List<String> jobIds)

jobDefinitionId

public JobQueryDto jobDefinitionId(String jobDefinitionId)

getJobDefinitionId

@Nullable
public String getJobDefinitionId()

Only select jobs which exist for the given job definition.

Returns:

jobDefinitionId

setJobDefinitionId

public void setJobDefinitionId(String jobDefinitionId)

processInstanceId

public JobQueryDto processInstanceId(String processInstanceId)

getProcessInstanceId

@Nullable
public String getProcessInstanceId()

Only select jobs which exist for the given process instance.

Returns:

processInstanceId

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

processInstanceIds

public JobQueryDto processInstanceIds(List<String> processInstanceIds)

addProcessInstanceIdsItem

public JobQueryDto addProcessInstanceIdsItem(String processInstanceIdsItem)

getProcessInstanceIds

@Nullable
public List<String> getProcessInstanceIds()

Only select jobs which exist for the given list of process instance ids.

Returns:

processInstanceIds

setProcessInstanceIds

public void setProcessInstanceIds(List<String> processInstanceIds)

executionId

public JobQueryDto executionId(String executionId)

getExecutionId

@Nullable
public String getExecutionId()

Only select jobs which exist for the given execution.

Returns:

executionId

setExecutionId

public void setExecutionId(String executionId)

processDefinitionId

public JobQueryDto processDefinitionId(String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

Filter by the id of the process definition the jobs run on.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

processDefinitionKey

public JobQueryDto processDefinitionKey(String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

Filter by the key of the process definition the jobs run on.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

activityId

public JobQueryDto activityId(String activityId)

getActivityId

@Nullable
public String getActivityId()

Only select jobs which exist for an activity with the given id.

Returns:

activityId

setActivityId

public void setActivityId(String activityId)

withRetriesLeft

public JobQueryDto withRetriesLeft(Boolean withRetriesLeft)

getWithRetriesLeft

@Nullable
public Boolean getWithRetriesLeft()

Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior.

Returns:

withRetriesLeft

setWithRetriesLeft

public void setWithRetriesLeft(Boolean withRetriesLeft)

executable

public JobQueryDto executable(Boolean executable)

getExecutable

@Nullable
public Boolean getExecutable()

Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior.

Returns:

executable

setExecutable

public void setExecutable(Boolean executable)

timers

public JobQueryDto timers(Boolean timers)

getTimers

@Nullable
public Boolean getTimers()

Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior.

Returns:

timers

setTimers

public void setTimers(Boolean timers)

messages

public JobQueryDto messages(Boolean messages)

getMessages

@Nullable
public Boolean getMessages()

Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior.

Returns:

messages

setMessages

public void setMessages(Boolean messages)

dueDates

public JobQueryDto dueDates(List<JobConditionQueryParameterDto> dueDates)

addDueDatesItem

public JobQueryDto addDueDatesItem(JobConditionQueryParameterDto dueDatesItem)

getDueDates

@Nullable
public List<JobConditionQueryParameterDto> getDueDates()

Only select jobs where the due date is lower or higher than the given date.

Returns:

dueDates

setDueDates

public void setDueDates(List<JobConditionQueryParameterDto> dueDates)

createTimes

public JobQueryDto createTimes(List<JobConditionQueryParameterDto> createTimes)

addCreateTimesItem

public JobQueryDto addCreateTimesItem(JobConditionQueryParameterDto createTimesItem)

getCreateTimes

@Nullable
public List<JobConditionQueryParameterDto> getCreateTimes()

Only select jobs created before or after the given date.

Returns:

createTimes

setCreateTimes

public void setCreateTimes(List<JobConditionQueryParameterDto> createTimes)

withException

public JobQueryDto withException(Boolean withException)

getWithException

@Nullable
public Boolean getWithException()

Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior.

Returns:

withException

setWithException

public void setWithException(Boolean withException)

exceptionMessage

public JobQueryDto exceptionMessage(String exceptionMessage)

getExceptionMessage

@Nullable
public String getExceptionMessage()

Only select jobs that failed due to an exception with the given message.

Returns:

exceptionMessage

setExceptionMessage

public void setExceptionMessage(String exceptionMessage)

failedActivityId

public JobQueryDto failedActivityId(String failedActivityId)

getFailedActivityId

@Nullable
public String getFailedActivityId()

Only select jobs that failed due to an exception at an activity with the given id.

Returns:

failedActivityId

setFailedActivityId

public void setFailedActivityId(String failedActivityId)

noRetriesLeft

public JobQueryDto noRetriesLeft(Boolean noRetriesLeft)

getNoRetriesLeft

@Nullable
public Boolean getNoRetriesLeft()

Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior.

Returns:

noRetriesLeft

setNoRetriesLeft

public void setNoRetriesLeft(Boolean noRetriesLeft)

active

public JobQueryDto active(Boolean active)

getActive

@Nullable
public Boolean getActive()

Only include active jobs. Value may only be `true`, as `false` is the default behavior.

Returns:

active

setActive

public void setActive(Boolean active)

suspended

public JobQueryDto suspended(Boolean suspended)

getSuspended

@Nullable
public Boolean getSuspended()

Only include suspended jobs. Value may only be `true`, as `false` is the default behavior.

Returns:

suspended

setSuspended

public void setSuspended(Boolean suspended)

priorityLowerThanOrEquals

public JobQueryDto 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)

priorityHigherThanOrEquals

public JobQueryDto 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)

tenantIdIn

public JobQueryDto tenantIdIn(List<String> tenantIdIn)

addTenantIdInItem

public JobQueryDto addTenantIdInItem(String tenantIdInItem)

getTenantIdIn

@Nullable
public List<String> getTenantIdIn()

Only include jobs which belong to one of the passed tenant ids.

Returns:

tenantIdIn

setTenantIdIn

public void setTenantIdIn(List<String> tenantIdIn)

withoutTenantId

public JobQueryDto withoutTenantId(Boolean withoutTenantId)

getWithoutTenantId

@Nullable
public Boolean getWithoutTenantId()

Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior.

Returns:

withoutTenantId

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

includeJobsWithoutTenantId

public JobQueryDto includeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)

getIncludeJobsWithoutTenantId

@Nullable
public Boolean getIncludeJobsWithoutTenantId()

Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.

Returns:

includeJobsWithoutTenantId

setIncludeJobsWithoutTenantId

public void setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)

sorting

public JobQueryDto sorting(List<JobQueryDtoSorting> sorting)

addSortingItem

public JobQueryDto addSortingItem(JobQueryDtoSorting sortingItem)

getSorting

@Nullable
public List<JobQueryDtoSorting> getSorting()

An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Does not have an effect for the `count` endpoint.

Returns:

sorting

setSorting

public void setSorting(List<JobQueryDtoSorting> 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