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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactivityId(String activityId) deploymentId(String deploymentId) booleanThe id of the activity this job definition is associated with.org.openapitools.jackson.nullable.JsonNullable<String>The id of the deployment this job definition is related to.org.openapitools.jackson.nullable.JsonNullable<String>getId()The id of the job definition.org.openapitools.jackson.nullable.JsonNullable<String>The configuration of a job definition provides details about the jobs which will be created.org.openapitools.jackson.nullable.JsonNullable<String>The type of the job which is running for this job definition.org.openapitools.jackson.nullable.JsonNullable<String>The execution priority defined for jobs that are created based on this definition.org.openapitools.jackson.nullable.JsonNullable<Long>The id of the process definition this job definition is associated with.org.openapitools.jackson.nullable.JsonNullable<String>The key of the process definition this job definition is associated with.org.openapitools.jackson.nullable.JsonNullable<String>Indicates whether this job definition is suspended or not.org.openapitools.jackson.nullable.JsonNullable<Boolean>The id of the tenant this job definition is associated with.org.openapitools.jackson.nullable.JsonNullable<String>inthashCode()jobConfiguration(String jobConfiguration) overridingJobPriority(Long overridingJobPriority) processDefinitionId(String processDefinitionId) processDefinitionKey(String processDefinitionKey) voidsetActivityId(String activityId) voidsetActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityId) voidsetDeploymentId(String deploymentId) voidsetDeploymentId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> deploymentId) voidvoidsetId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> id) voidsetJobConfiguration(String jobConfiguration) voidsetJobConfiguration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobConfiguration) voidsetJobType(String jobType) voidsetJobType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobType) voidsetOverridingJobPriority(Long overridingJobPriority) voidsetOverridingJobPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> overridingJobPriority) voidsetProcessDefinitionId(String processDefinitionId) voidsetProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId) voidsetProcessDefinitionKey(String processDefinitionKey) voidsetProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey) voidsetSuspended(Boolean suspended) voidsetSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended) voidsetTenantId(String tenantId) voidsetTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tenantId) toString()Convert the instance into URL query string.toUrlQueryString(String prefix) Convert the instance into URL query string.
-
Field Details
-
JSON_PROPERTY_ID
- See Also:
-
JSON_PROPERTY_PROCESS_DEFINITION_ID
- See Also:
-
JSON_PROPERTY_PROCESS_DEFINITION_KEY
- See Also:
-
JSON_PROPERTY_ACTIVITY_ID
- See Also:
-
JSON_PROPERTY_JOB_TYPE
- See Also:
-
JSON_PROPERTY_JOB_CONFIGURATION
- See Also:
-
JSON_PROPERTY_OVERRIDING_JOB_PRIORITY
- See Also:
-
JSON_PROPERTY_SUSPENDED
- See Also:
-
JSON_PROPERTY_TENANT_ID
- See Also:
-
JSON_PROPERTY_DEPLOYMENT_ID
- See Also:
-
-
Constructor Details
-
JobDefinitionDto
public JobDefinitionDto()
-
-
Method Details
-
id
-
getId
The id of the job definition.- Returns:
- id
-
getId_JsonNullable
-
setId_JsonNullable
-
setId
-
processDefinitionId
-
getProcessDefinitionId
The id of the process definition this job definition is associated with.- Returns:
- processDefinitionId
-
getProcessDefinitionId_JsonNullable
-
setProcessDefinitionId_JsonNullable
public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId) -
setProcessDefinitionId
-
processDefinitionKey
-
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
-
activityId
-
getActivityId
The id of the activity this job definition is associated with.- Returns:
- activityId
-
getActivityId_JsonNullable
-
setActivityId_JsonNullable
public void setActivityId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> activityId) -
setActivityId
-
jobType
-
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
-
setJobType_JsonNullable
-
setJobType
-
jobConfiguration
-
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
-
setJobConfiguration_JsonNullable
public void setJobConfiguration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobConfiguration) -
setJobConfiguration
-
overridingJobPriority
-
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
-
setOverridingJobPriority_JsonNullable
public void setOverridingJobPriority_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> overridingJobPriority) -
setOverridingJobPriority
-
suspended
-
getSuspended
Indicates whether this job definition is suspended or not.- Returns:
- suspended
-
getSuspended_JsonNullable
-
setSuspended_JsonNullable
public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended) -
setSuspended
-
tenantId
-
getTenantId
The id of the tenant this job definition is associated with.- Returns:
- tenantId
-
getTenantId_JsonNullable
-
setTenantId_JsonNullable
public void setTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tenantId) -
setTenantId
-
deploymentId
-
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
-
setDeploymentId_JsonNullable
public void setDeploymentId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> deploymentId) -
setDeploymentId
-
equals
-
hashCode
public int hashCode() -
toString
-
toUrlQueryString
Convert the instance into URL query string.- Returns:
- URL query string
-
toUrlQueryString
Convert the instance into URL query string.- Parameters:
prefix- prefix of the query string- Returns:
- URL query string
-