Package org.camunda.community.rest.client.dto

Class JobQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.JobQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class JobQueryDto extends Object
A Job instance query which defines a list of Job instances

  • Field Details

  • Constructor Details

    • JobQueryDto

      public JobQueryDto()

  • Method Details

    • jobId

      public JobQueryDto jobId(String jobId)

    • getJobId

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

    • getJobId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getJobId_JsonNullable()

    • setJobId_JsonNullable

      public void setJobId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getJobIds_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getJobIds_JsonNullable()

    • setJobIds_JsonNullable

      public void setJobIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> 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

    • getJobDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getJobDefinitionId_JsonNullable()

    • setJobDefinitionId_JsonNullable

      public void setJobDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceId_JsonNullable()

    • setProcessInstanceId_JsonNullable

      public void setProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getProcessInstanceIds_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getProcessInstanceIds_JsonNullable()

    • setProcessInstanceIds_JsonNullable

      public void setProcessInstanceIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> 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

    • getExecutionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExecutionId_JsonNullable()

    • setExecutionId_JsonNullable

      public void setExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getProcessDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionId_JsonNullable()

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getProcessDefinitionKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionKey_JsonNullable()

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getActivityId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getActivityId_JsonNullable()

    • setActivityId_JsonNullable

      public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getWithRetriesLeft_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithRetriesLeft_JsonNullable()

    • setWithRetriesLeft_JsonNullable

      public void setWithRetriesLeft_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getExecutable_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getExecutable_JsonNullable()

    • setExecutable_JsonNullable

      public void setExecutable_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getTimers_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getTimers_JsonNullable()

    • setTimers_JsonNullable

      public void setTimers_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getMessages_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getMessages_JsonNullable()

    • setMessages_JsonNullable

      public void setMessages_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getDueDates_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<JobConditionQueryParameterDto>> getDueDates_JsonNullable()

    • setDueDates_JsonNullable

      public void setDueDates_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<JobConditionQueryParameterDto>> 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

    • getCreateTimes_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<JobConditionQueryParameterDto>> getCreateTimes_JsonNullable()

    • setCreateTimes_JsonNullable

      public void setCreateTimes_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<JobConditionQueryParameterDto>> 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

    • getWithException_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithException_JsonNullable()

    • setWithException_JsonNullable

      public void setWithException_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getExceptionMessage_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExceptionMessage_JsonNullable()

    • setExceptionMessage_JsonNullable

      public void setExceptionMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getFailedActivityId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getFailedActivityId_JsonNullable()

    • setFailedActivityId_JsonNullable

      public void setFailedActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getNoRetriesLeft_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getNoRetriesLeft_JsonNullable()

    • setNoRetriesLeft_JsonNullable

      public void setNoRetriesLeft_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getActive_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getActive_JsonNullable()

    • setActive_JsonNullable

      public void setActive_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getSuspended_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSuspended_JsonNullable()

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getPriorityLowerThanOrEquals_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getPriorityLowerThanOrEquals_JsonNullable()

    • setPriorityLowerThanOrEquals_JsonNullable

      public void setPriorityLowerThanOrEquals_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> 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

    • getPriorityHigherThanOrEquals_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getPriorityHigherThanOrEquals_JsonNullable()

    • setPriorityHigherThanOrEquals_JsonNullable

      public void setPriorityHigherThanOrEquals_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> 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

    • getTenantIdIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTenantIdIn_JsonNullable()

    • setTenantIdIn_JsonNullable

      public void setTenantIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> 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

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getIncludeJobsWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getIncludeJobsWithoutTenantId_JsonNullable()

    • setIncludeJobsWithoutTenantId_JsonNullable

      public void setIncludeJobsWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeJobsWithoutTenantId)

    • setIncludeJobsWithoutTenantId

      public void setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)

    • sorting

      public JobQueryDto sorting(List<JobQueryDtoSortingInner> sorting)

    • addSortingItem

      public JobQueryDto addSortingItem(JobQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<JobQueryDtoSortingInner> 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

    • getSorting_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<JobQueryDtoSortingInner>> getSorting_JsonNullable()

    • setSorting_JsonNullable

      public void setSorting_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<JobQueryDtoSortingInner>> sorting)

    • setSorting

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

    • 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