Package io.camunda.client.protocol.rest

Class ActivatedJobResult

java.lang.Object

io.camunda.client.protocol.rest.ActivatedJobResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class ActivatedJobResult
extends Object

ActivatedJobResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
static final String	JSON_PROPERTY_CUSTOM_HEADERS
static final String	JSON_PROPERTY_DEADLINE
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_JOB_KEY
static final String	JSON_PROPERTY_KIND
static final String	JSON_PROPERTY_LEASE_TOKEN
static final String	JSON_PROPERTY_LISTENER_EVENT_TYPE
static final String	JSON_PROPERTY_PHYSICAL_TENANT_ID
static final String	JSON_PROPERTY_PRIORITY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_RETRIES
static final String	JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_USER_TASK
static final String	JSON_PROPERTY_VARIABLES
static final String	JSON_PROPERTY_WORKER

Constructor Summary

Constructors

Constructor	Description
ActivatedJobResult()

Method Summary

Modifier and Type	Method	Description
ActivatedJobResult	addTagsItem(String tagsItem)
ActivatedJobResult	businessId(String businessId)
ActivatedJobResult	customHeaders(Map<String,Object> customHeaders)
ActivatedJobResult	deadline(Long deadline)
ActivatedJobResult	elementId(String elementId)
ActivatedJobResult	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
String	getBusinessId()	The business ID of the owning process instance, inherited when the job was created.
Map<String,Object>	getCustomHeaders()	A set of custom headers defined during modelling; returned as a serialized JSON document.
Long	getDeadline()	When the job can be activated again, sent as a UNIX epoch timestamp.
String	getElementId()	The associated task element ID.
String	getElementInstanceKey()	The element instance key of the task.
String	getJobKey()	The key, a unique identifier for the job.
JobKindEnum	getKind()	Get kind
String	getLeaseToken()	The lease token identifying this activation.
JobListenerEventTypeEnum	getListenerEventType()	Get listenerEventType
String	getPhysicalTenantId()	The ID of the physical tenant that the job-activation request was routed to; the default physical tenant when the request did not specify one.
Integer	getPriority()	The priority of the job.
String	getProcessDefinitionId()	The bpmn process ID of the job's process definition.
String	getProcessDefinitionKey()	The key of the job's process definition.
Integer	getProcessDefinitionVersion()	The version of the job's process definition.
String	getProcessInstanceKey()	The job's process instance key.
Integer	getRetries()	The amount of retries left to this job (should always be positive).
String	getRootProcessInstanceKey()	The key of the root process instance.
Set<String>	getTags()	List of tags.
String	getTenantId()	The ID of the tenant that owns the job.
String	getType()	The type of the job (should match what was requested).
UserTaskProperties	getUserTask()	User task properties, if the job is a user task.
Map<String,Object>	getVariables()	All variables visible to the task scope, computed at activation time.
String	getWorker()	The name of the worker which activated this job.
int	hashCode()
ActivatedJobResult	jobKey(String jobKey)
ActivatedJobResult	kind(JobKindEnum kind)
ActivatedJobResult	leaseToken(String leaseToken)
ActivatedJobResult	listenerEventType(JobListenerEventTypeEnum listenerEventType)
ActivatedJobResult	physicalTenantId(String physicalTenantId)
ActivatedJobResult	priority(Integer priority)
ActivatedJobResult	processDefinitionId(String processDefinitionId)
ActivatedJobResult	processDefinitionKey(String processDefinitionKey)
ActivatedJobResult	processDefinitionVersion(Integer processDefinitionVersion)
ActivatedJobResult	processInstanceKey(String processInstanceKey)
ActivatedJobResult	putCustomHeadersItem(String key, Object customHeadersItem)
ActivatedJobResult	putVariablesItem(String key, Object variablesItem)
ActivatedJobResult	retries(Integer retries)
ActivatedJobResult	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setBusinessId(String businessId)
void	setCustomHeaders(Map<String,Object> customHeaders)
void	setDeadline(Long deadline)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setJobKey(String jobKey)
void	setKind(JobKindEnum kind)
void	setLeaseToken(String leaseToken)
void	setListenerEventType(JobListenerEventTypeEnum listenerEventType)
void	setPhysicalTenantId(String physicalTenantId)
void	setPriority(Integer priority)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessInstanceKey(String processInstanceKey)
void	setRetries(Integer retries)
void	setRootProcessInstanceKey(String rootProcessInstanceKey)
void	setTags(Set<String> tags)
void	setTenantId(String tenantId)
void	setType(String type)
void	setUserTask(UserTaskProperties userTask)
void	setVariables(Map<String,Object> variables)
void	setWorker(String worker)
ActivatedJobResult	tags(Set<String> tags)
ActivatedJobResult	tenantId(String tenantId)
String	toString()
ActivatedJobResult	type(String type)
ActivatedJobResult	userTask(UserTaskProperties userTask)
ActivatedJobResult	variables(Map<String,Object> variables)
ActivatedJobResult	worker(String worker)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_HEADERS

public static final String JSON_PROPERTY_CUSTOM_HEADERS

See Also:

• Constant Field Values

JSON_PROPERTY_WORKER

public static final String JSON_PROPERTY_WORKER

See Also:

• Constant Field Values

JSON_PROPERTY_RETRIES

public static final String JSON_PROPERTY_RETRIES

See Also:

• Constant Field Values

JSON_PROPERTY_DEADLINE

public static final String JSON_PROPERTY_DEADLINE

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PHYSICAL_TENANT_ID

public static final String JSON_PROPERTY_PHYSICAL_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_KEY

public static final String JSON_PROPERTY_JOB_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_KIND

public static final String JSON_PROPERTY_KIND

See Also:

• Constant Field Values

JSON_PROPERTY_LISTENER_EVENT_TYPE

public static final String JSON_PROPERTY_LISTENER_EVENT_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_USER_TASK

public static final String JSON_PROPERTY_USER_TASK

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PRIORITY

public static final String JSON_PROPERTY_PRIORITY

See Also:

• Constant Field Values

JSON_PROPERTY_LEASE_TOKEN

public static final String JSON_PROPERTY_LEASE_TOKEN

See Also:

• Constant Field Values

Constructor Details

ActivatedJobResult

public ActivatedJobResult()

Method Details

type

public ActivatedJobResult type(@Nonnull
 String type)

getType

@Nonnull
public String getType()

The type of the job (should match what was requested).

Returns:

type

setType

public void setType(@Nonnull
 String type)

processDefinitionId

public ActivatedJobResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

The bpmn process ID of the job's process definition.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 String processDefinitionId)

processDefinitionVersion

public ActivatedJobResult processDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nonnull
public Integer getProcessDefinitionVersion()

The version of the job's process definition.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

elementId

public ActivatedJobResult elementId(@Nonnull
 String elementId)

getElementId

@Nonnull
public String getElementId()

The associated task element ID.

Returns:

elementId

setElementId

public void setElementId(@Nonnull
 String elementId)

customHeaders

public ActivatedJobResult customHeaders(@Nonnull
 Map<String,Object> customHeaders)

putCustomHeadersItem

public ActivatedJobResult putCustomHeadersItem(String key,
 Object customHeadersItem)

getCustomHeaders

@Nonnull
public Map<String,Object> getCustomHeaders()

A set of custom headers defined during modelling; returned as a serialized JSON document.

Returns:

customHeaders

setCustomHeaders

public void setCustomHeaders(@Nonnull
 Map<String,Object> customHeaders)

worker

public ActivatedJobResult worker(@Nonnull
 String worker)

getWorker

@Nonnull
public String getWorker()

The name of the worker which activated this job.

Returns:

worker

setWorker

public void setWorker(@Nonnull
 String worker)

retries

public ActivatedJobResult retries(@Nonnull
 Integer retries)

getRetries

@Nonnull
public Integer getRetries()

The amount of retries left to this job (should always be positive).

Returns:

retries

setRetries

public void setRetries(@Nonnull
 Integer retries)

deadline

public ActivatedJobResult deadline(@Nonnull
 Long deadline)

getDeadline

@Nonnull
public Long getDeadline()

When the job can be activated again, sent as a UNIX epoch timestamp.

Returns:

deadline

setDeadline

public void setDeadline(@Nonnull
 Long deadline)

variables

public ActivatedJobResult variables(@Nonnull
 Map<String,Object> variables)

putVariablesItem

public ActivatedJobResult putVariablesItem(String key,
 Object variablesItem)

getVariables

@Nonnull
public Map<String,Object> getVariables()

All variables visible to the task scope, computed at activation time.

Returns:

variables

setVariables

public void setVariables(@Nonnull
 Map<String,Object> variables)

tenantId

public ActivatedJobResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The ID of the tenant that owns the job.

Returns:

tenantId

setTenantId

public void setTenantId(@Nonnull
 String tenantId)

physicalTenantId

public ActivatedJobResult physicalTenantId(@Nonnull
 String physicalTenantId)

getPhysicalTenantId

@Nonnull
public String getPhysicalTenantId()

The ID of the physical tenant that the job-activation request was routed to; the default physical tenant when the request did not specify one.

Returns:

physicalTenantId

setPhysicalTenantId

public void setPhysicalTenantId(@Nonnull
 String physicalTenantId)

jobKey

public ActivatedJobResult jobKey(@Nonnull
 String jobKey)

getJobKey

@Nonnull
public String getJobKey()

The key, a unique identifier for the job.

Returns:

jobKey

setJobKey

public void setJobKey(@Nonnull
 String jobKey)

processInstanceKey

public ActivatedJobResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The job's process instance key.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

processDefinitionKey

public ActivatedJobResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The key of the job's process definition.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 String processDefinitionKey)

elementInstanceKey

public ActivatedJobResult elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The element instance key of the task.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

kind

public ActivatedJobResult kind(@Nonnull
 JobKindEnum kind)

getKind

@Nonnull
public JobKindEnum getKind()

Get kind

Returns:

kind

setKind

public void setKind(@Nonnull
 JobKindEnum kind)

listenerEventType

public ActivatedJobResult listenerEventType(@Nonnull
 JobListenerEventTypeEnum listenerEventType)

getListenerEventType

@Nonnull
public JobListenerEventTypeEnum getListenerEventType()

Get listenerEventType

Returns:

listenerEventType

setListenerEventType

public void setListenerEventType(@Nonnull
 JobListenerEventTypeEnum listenerEventType)

userTask

public ActivatedJobResult userTask(@Nullable
 UserTaskProperties userTask)

getUserTask

@Nullable
public UserTaskProperties getUserTask()

User task properties, if the job is a user task. This is `null` if the job is not a user task.

Returns:

userTask

setUserTask

public void setUserTask(@Nullable
 UserTaskProperties userTask)

tags

public ActivatedJobResult tags(@Nonnull
 Set<String> tags)

addTagsItem

public ActivatedJobResult addTagsItem(String tagsItem)

getTags

@Nonnull
public Set<String> getTags()

List of tags. Tags need to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100.

Returns:

tags

setTags

public void setTags(@Nonnull
 Set<String> tags)

rootProcessInstanceKey

public ActivatedJobResult rootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

getRootProcessInstanceKey

@Nullable
public String getRootProcessInstanceKey()

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

Returns:

rootProcessInstanceKey

setRootProcessInstanceKey

public void setRootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

businessId

public ActivatedJobResult businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

The business ID of the owning process instance, inherited when the job was created. This is `null` for jobs created before version 8.10 and for jobs whose owning process instance has no business ID.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

priority

public ActivatedJobResult priority(@Nonnull
 Integer priority)

getPriority

@Nonnull
public Integer getPriority()

The priority of the job. Higher values indicate higher priority. Jobs created before 8.10 have no stored priority; the API returns 0 for such jobs.

Returns:

priority

setPriority

public void setPriority(@Nonnull
 Integer priority)

leaseToken

public ActivatedJobResult leaseToken(@Nullable
 String leaseToken)

getLeaseToken

@Nullable
public String getLeaseToken()

The lease token identifying this activation. This is `null` when the job was activated without a lease.

Returns:

leaseToken

setLeaseToken

public void setLeaseToken(@Nullable
 String leaseToken)

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