Package org.openapitools.client.model

Class JobQueryDto

  • public class JobQueryDto
extends Object
    A Job instance query which defines a list of Job instances

    • Constructor Detail

      • JobQueryDto

        public JobQueryDto()

    • Method Detail

      • getJobId

        public String getJobId()
        Filter by job id.
        Returns:
        jobId

      • setJobId

        public void setJobId​(String jobId)

      • getJobIds

        public List<String> getJobIds()
        Filter by a list of job ids.
        Returns:
        jobIds

      • setJobIds

        public void setJobIds​(List<String> jobIds)

      • getJobDefinitionId

        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

        public String getProcessInstanceId()
        Only select jobs which exist for the given process instance.
        Returns:
        processInstanceId

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • addProcessInstanceIdsItem

        public JobQueryDto addProcessInstanceIdsItem​(String processInstanceIdsItem)

      • getProcessInstanceIds

        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)

      • getExecutionId

        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

        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

        public String getProcessDefinitionKey()
        Filter by the key of the process definition the jobs run on.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getActivityId

        public String getActivityId()
        Only select jobs which exist for an activity with the given id.
        Returns:
        activityId

      • setActivityId

        public void setActivityId​(String activityId)

      • getWithRetriesLeft

        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)

      • getExecutable

        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)

      • getTimers

        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)

      • getMessages

        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)

      • getDueDates

        public List<JobConditionQueryParameterDto> getDueDates()
        Only select jobs where the due date is lower or higher than the given date.
        Returns:
        dueDates

      • getWithException

        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

        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

        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)

      • getNoRetriesLeft

        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)

      • getActive

        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)

      • getSuspended

        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

        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

        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)

      • addTenantIdInItem

        public JobQueryDto addTenantIdInItem​(String tenantIdInItem)

      • getTenantIdIn

        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)

      • getWithoutTenantId

        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

        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)

      • getSorting

        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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object