Package io.camunda.client.protocol.rest

Class ActivatedJobResult

java.lang.Object

io.camunda.client.protocol.rest.ActivatedJobResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class ActivatedJobResult
extends Object

ActivatedJobResult

Field Summary

Fields

Modifier and Type	Field	Description
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_LISTENER_EVENT_TYPE
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_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	customHeaders(Map<String,Object> customHeaders)
ActivatedJobResult	deadline(Long deadline)
ActivatedJobResult	elementId(String elementId)
ActivatedJobResult	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
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 unique key identifying the associated task, unique within the scope of the process instance.
String	getJobKey()	The key, a unique identifier for the job.
JobKindEnum	getKind()	Get kind
JobListenerEventTypeEnum	getListenerEventType()	Get listenerEventType
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).
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()	Get userTask
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	listenerEventType(JobListenerEventTypeEnum listenerEventType)
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)
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	setListenerEventType(JobListenerEventTypeEnum listenerEventType)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessInstanceKey(String processInstanceKey)
void	setRetries(Integer retries)
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()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
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_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

Constructor Details

ActivatedJobResult

public ActivatedJobResult()

Method Details

type

public ActivatedJobResult type(@Nullable
 String type)

getType

@Nullable
public String getType()

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

Returns:

type

setType

public void setType(@Nullable
 String type)

processDefinitionId

public ActivatedJobResult processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

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

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

processDefinitionVersion

public ActivatedJobResult processDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

The version of the job's process definition.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

elementId

public ActivatedJobResult elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The associated task element ID.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

customHeaders

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

putCustomHeadersItem

public ActivatedJobResult putCustomHeadersItem(String key,
 Object customHeadersItem)

getCustomHeaders

@Nullable
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(@Nullable
 Map<String,Object> customHeaders)

worker

public ActivatedJobResult worker(@Nullable
 String worker)

getWorker

@Nullable
public String getWorker()

The name of the worker which activated this job.

Returns:

worker

setWorker

public void setWorker(@Nullable
 String worker)

retries

public ActivatedJobResult retries(@Nullable
 Integer retries)

getRetries

@Nullable
public Integer getRetries()

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

Returns:

retries

setRetries

public void setRetries(@Nullable
 Integer retries)

deadline

public ActivatedJobResult deadline(@Nullable
 Long deadline)

getDeadline

@Nullable
public Long getDeadline()

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

Returns:

deadline

setDeadline

public void setDeadline(@Nullable
 Long deadline)

variables

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

putVariablesItem

public ActivatedJobResult putVariablesItem(String key,
 Object variablesItem)

getVariables

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

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

Returns:

variables

setVariables

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

tenantId

public ActivatedJobResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The ID of the tenant that owns the job.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

jobKey

public ActivatedJobResult jobKey(@Nullable
 String jobKey)

getJobKey

@Nullable
public String getJobKey()

The key, a unique identifier for the job.

Returns:

jobKey

setJobKey

public void setJobKey(@Nullable
 String jobKey)

processInstanceKey

public ActivatedJobResult processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The job's process instance key.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

processDefinitionKey

public ActivatedJobResult processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The key of the job's process definition.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

elementInstanceKey

public ActivatedJobResult elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

The unique key identifying the associated task, unique within the scope of the process instance.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

kind

public ActivatedJobResult kind(@Nullable
 JobKindEnum kind)

getKind

@Nullable
public JobKindEnum getKind()

Get kind

Returns:

kind

setKind

public void setKind(@Nullable
 JobKindEnum kind)

listenerEventType

public ActivatedJobResult listenerEventType(@Nullable
 JobListenerEventTypeEnum listenerEventType)

getListenerEventType

@Nullable
public JobListenerEventTypeEnum getListenerEventType()

Get listenerEventType

Returns:

listenerEventType

setListenerEventType

public void setListenerEventType(@Nullable
 JobListenerEventTypeEnum listenerEventType)

userTask

public ActivatedJobResult userTask(@Nullable
 UserTaskProperties userTask)

getUserTask

@Nullable
public UserTaskProperties getUserTask()

Get userTask

Returns:

userTask

setUserTask

public void setUserTask(@Nullable
 UserTaskProperties userTask)

tags

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

addTagsItem

public ActivatedJobResult addTagsItem(String tagsItem)

getTags

@Nullable
public Set<String> getTags()

List of tags

Returns:

tags

setTags

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

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