Class JobDefinitionDto

java.lang.Object
org.camunda.community.rest.client.dto.JobDefinitionDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class JobDefinitionDto extends Object
JobDefinitionDto
  • Field Details

  • Constructor Details

    • JobDefinitionDto

      public JobDefinitionDto()
  • Method Details

    • id

      public JobDefinitionDto id(String id)
    • getId

      @Nullable public String getId()
      The id of the job definition.
      Returns:
      id
    • getId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getId_JsonNullable()
    • setId_JsonNullable

      public void setId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> id)
    • setId

      public void setId(String id)
    • processDefinitionId

      public JobDefinitionDto processDefinitionId(String processDefinitionId)
    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The id of the process definition this job definition is associated with.
      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 JobDefinitionDto processDefinitionKey(String processDefinitionKey)
    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The key of the process definition this job definition is associated with.
      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 JobDefinitionDto activityId(String activityId)
    • getActivityId

      @Nullable public String getActivityId()
      The id of the activity this job definition is associated with.
      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)
    • jobType

      public JobDefinitionDto jobType(String jobType)
    • getJobType

      @Nullable public String getJobType()
      The type of the job which is running for this job definition. 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 JobDefinitionDto jobConfiguration(String jobConfiguration)
    • getJobConfiguration

      @Nullable public String getJobConfiguration()
      The configuration of a job definition provides details about the jobs which will be created. 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)
    • overridingJobPriority

      public JobDefinitionDto overridingJobPriority(Long overridingJobPriority)
    • getOverridingJobPriority

      @Nullable public Long getOverridingJobPriority()
      The execution priority defined for jobs that are created based on this definition. May be `null` when the priority has not been overridden on the job definition level.
      Returns:
      overridingJobPriority
    • getOverridingJobPriority_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getOverridingJobPriority_JsonNullable()
    • setOverridingJobPriority_JsonNullable

      public void setOverridingJobPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> overridingJobPriority)
    • setOverridingJobPriority

      public void setOverridingJobPriority(Long overridingJobPriority)
    • suspended

      public JobDefinitionDto suspended(Boolean suspended)
    • getSuspended

      @Nullable public Boolean getSuspended()
      Indicates whether this job definition is suspended or not.
      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)
    • tenantId

      public JobDefinitionDto tenantId(String tenantId)
    • getTenantId

      @Nullable public String getTenantId()
      The id of the tenant this job definition is associated with.
      Returns:
      tenantId
    • getTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTenantId_JsonNullable()
    • setTenantId_JsonNullable

      public void setTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tenantId)
    • setTenantId

      public void setTenantId(String tenantId)
    • deploymentId

      public JobDefinitionDto deploymentId(String deploymentId)
    • getDeploymentId

      @Nullable public String getDeploymentId()
      The id of the deployment this job definition is related to. In a deployment-aware setup, this leads to all jobs of the same definition being executed on the same node.
      Returns:
      deploymentId
    • getDeploymentId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getDeploymentId_JsonNullable()
    • setDeploymentId_JsonNullable

      public void setDeploymentId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> deploymentId)
    • setDeploymentId

      public void setDeploymentId(String deploymentId)
    • 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