Package org.openapitools.client.model

Class JobDefinitionQueryDto

  • public class JobDefinitionQueryDto
extends Object
    A Job definition query which defines a list of Job definitions

    • Constructor Detail

      • JobDefinitionQueryDto

        public JobDefinitionQueryDto()

    • Method Detail

      • getJobDefinitionId

        public String getJobDefinitionId()
        Filter by job definition id.
        Returns:
        jobDefinitionId

      • setJobDefinitionId

        public void setJobDefinitionId​(String jobDefinitionId)

      • getActivityIdIn

        public List<String> getActivityIdIn()
        Only include job definitions which belong to one of the passed activity ids.
        Returns:
        activityIdIn

      • setActivityIdIn

        public void setActivityIdIn​(List<String> activityIdIn)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Only include job definitions which exist for the given process definition id.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        Only include job definitions which exist for the given process definition key.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getJobType

        public String getJobType()
        Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types.
        Returns:
        jobType

      • setJobType

        public void setJobType​(String jobType)

      • getJobConfiguration

        public String getJobConfiguration()
        Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration.
        Returns:
        jobConfiguration

      • setJobConfiguration

        public void setJobConfiguration​(String jobConfiguration)

      • getActive

        public Boolean getActive()
        Only include active job definitions. 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 job definitions. Value may only be `true`, as `false` is the default behavior.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • getWithOverridingJobPriority

        public Boolean getWithOverridingJobPriority()
        Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied.
        Returns:
        withOverridingJobPriority

      • setWithOverridingJobPriority

        public void setWithOverridingJobPriority​(Boolean withOverridingJobPriority)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Only include job definitions which belong to one of the passed tenant ids.
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getWithoutTenantId

        public Boolean getWithoutTenantId()
        Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withoutTenantId

      • setWithoutTenantId

        public void setWithoutTenantId​(Boolean withoutTenantId)

      • includeJobDefinitionsWithoutTenantId

        public JobDefinitionQueryDto includeJobDefinitionsWithoutTenantId​(Boolean includeJobDefinitionsWithoutTenantId)

      • getIncludeJobDefinitionsWithoutTenantId

        public Boolean getIncludeJobDefinitionsWithoutTenantId()
        Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior.
        Returns:
        includeJobDefinitionsWithoutTenantId

      • setIncludeJobDefinitionsWithoutTenantId

        public void setIncludeJobDefinitionsWithoutTenantId​(Boolean includeJobDefinitionsWithoutTenantId)

      • getSorting

        public List<JobDefinitionQueryDtoSorting> 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. Sorting has no effect for `count` endpoints.
        Returns:
        sorting

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object