Package io.camunda.client.protocol.rest
Class JobCompletionRequest
java.lang.Object
io.camunda.client.protocol.rest.JobCompletionRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class JobCompletionRequest
extends Object
JobCompletionRequest
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbusinessId(String businessId) booleanAn optional business id to assign to the process instance the job belongs to, as part of completing the job, letting a worker set the identifier from work it just performed.The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`.Get resultThe variables to complete the job with.inthashCode()leaseToken(String leaseToken) putVariablesItem(String key, Object variablesItem) voidsetBusinessId(String businessId) voidsetLeaseToken(String leaseToken) voidvoidsetVariables(Map<String, Object> variables) toString()
-
Field Details
-
JSON_PROPERTY_VARIABLES
- See Also:
-
JSON_PROPERTY_RESULT
- See Also:
-
JSON_PROPERTY_LEASE_TOKEN
- See Also:
-
JSON_PROPERTY_BUSINESS_ID
- See Also:
-
-
Constructor Details
-
JobCompletionRequest
public JobCompletionRequest()
-
-
Method Details
-
variables
-
putVariablesItem
-
getVariables
The variables to complete the job with.- Returns:
- variables
-
setVariables
-
result
-
getResult
Get result- Returns:
- result
-
setResult
-
leaseToken
-
getLeaseToken
The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`. For a leased job, the matching token must be supplied to prove the command comes from the worker that holds the current lease; a command with no token is rejected. A command carrying a stale token is likewise rejected, fencing the job against a superseded activation (for example, after the job timed out or failed and was re-activated by another worker). A job that was activated without a lease requires no token.- Returns:
- leaseToken
-
setLeaseToken
-
businessId
-
getBusinessId
An optional business id to assign to the process instance the job belongs to, as part of completing the job, letting a worker set the identifier from work it just performed. The business id can only be assigned to a root process instance: if the job belongs to a child process instance (one started by a call activity), the completion is rejected. An empty business id is likewise rejected. The assignment is single and irreversible and is only accepted while business id uniqueness is disabled. Only artifacts created after the assignment carry the business id; already-existing ones are not enriched. Completing with a business id that differs from one already assigned rejects the whole completion, leaving the job open; re-sending the identical business id is an idempotent no-op.- Returns:
- businessId
-
setBusinessId
-
equals
-
hashCode
public int hashCode() -
toString
-