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

Class JobDefinitionQueryDto

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

  • Field Details

  • Constructor Details

    • JobDefinitionQueryDto

      public JobDefinitionQueryDto()

  • Method Details

    • jobDefinitionId

      public JobDefinitionQueryDto jobDefinitionId(String jobDefinitionId)

    • getJobDefinitionId

      @Nullable public String getJobDefinitionId()
      Filter by job definition id.
      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)

    • activityIdIn

      public JobDefinitionQueryDto activityIdIn(List<String> activityIdIn)

    • addActivityIdInItem

      public JobDefinitionQueryDto addActivityIdInItem(String activityIdInItem)

    • getActivityIdIn

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

    • getActivityIdIn_JsonNullable

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

    • setActivityIdIn_JsonNullable

      public void setActivityIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> activityIdIn)

    • setActivityIdIn

      public void setActivityIdIn(List<String> activityIdIn)

    • processDefinitionId

      public JobDefinitionQueryDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Only include job definitions which exist for the given process definition id.
      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 JobDefinitionQueryDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Only include job definitions which exist for the given process definition key.
      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)

    • jobType

      public JobDefinitionQueryDto jobType(String jobType)

    • getJobType

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

    • getJobType_JsonNullable

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

    • setJobType_JsonNullable

      public void setJobType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobType)

    • setJobType

      public void setJobType(String jobType)

    • jobConfiguration

      public JobDefinitionQueryDto jobConfiguration(String jobConfiguration)

    • getJobConfiguration

      @Nullable 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

    • getJobConfiguration_JsonNullable

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

    • setJobConfiguration_JsonNullable

      public void setJobConfiguration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobConfiguration)

    • setJobConfiguration

      public void setJobConfiguration(String jobConfiguration)

    • active

      public JobDefinitionQueryDto active(Boolean active)

    • getActive

      @Nullable public Boolean getActive()
      Only include active job definitions. 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 JobDefinitionQueryDto suspended(Boolean suspended)

    • getSuspended

      @Nullable public Boolean getSuspended()
      Only include suspended job definitions. 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)

    • withOverridingJobPriority

      public JobDefinitionQueryDto withOverridingJobPriority(Boolean withOverridingJobPriority)

    • getWithOverridingJobPriority

      @Nullable 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

    • getWithOverridingJobPriority_JsonNullable

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

    • setWithOverridingJobPriority_JsonNullable

      public void setWithOverridingJobPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withOverridingJobPriority)

    • setWithOverridingJobPriority

      public void setWithOverridingJobPriority(Boolean withOverridingJobPriority)

    • tenantIdIn

      public JobDefinitionQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public JobDefinitionQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Only include job definitions 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 JobDefinitionQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable 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

    • 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)

    • includeJobDefinitionsWithoutTenantId

      public JobDefinitionQueryDto includeJobDefinitionsWithoutTenantId(Boolean includeJobDefinitionsWithoutTenantId)

    • getIncludeJobDefinitionsWithoutTenantId

      @Nullable 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

    • getIncludeJobDefinitionsWithoutTenantId_JsonNullable

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

    • setIncludeJobDefinitionsWithoutTenantId_JsonNullable

      public void setIncludeJobDefinitionsWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeJobDefinitionsWithoutTenantId)

    • setIncludeJobDefinitionsWithoutTenantId

      public void setIncludeJobDefinitionsWithoutTenantId(Boolean includeJobDefinitionsWithoutTenantId)

    • sorting

      public JobDefinitionQueryDto sorting(List<JobDefinitionQueryDtoSortingInner> sorting)

    • addSortingItem

      public JobDefinitionQueryDto addSortingItem(JobDefinitionQueryDtoSortingInner sortingItem)

    • getSorting

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

    • getSorting_JsonNullable

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

    • setSorting_JsonNullable

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

    • setSorting

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