Package io.camunda.zeebe.client.protocol.rest

Class ActivatedJob

java.lang.Object
io.camunda.zeebe.client.protocol.rest.ActivatedJob
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-10-28T16:53:53.401346729Z[GMT]", comments="Generator version: 7.8.0") public class ActivatedJob extends Object
ActivatedJob

  • Field Details

  • Constructor Details

    • ActivatedJob

      public ActivatedJob()

  • Method Details

    • jobKey

      public ActivatedJob jobKey(Long jobKey)

    • getJobKey

      @Nullable public Long getJobKey()
      the key, a unique identifier for the job
      Returns:
      jobKey

    • setJobKey

      public void setJobKey(Long jobKey)

    • type

      public ActivatedJob type(String type)

    • getType

      @Nullable public String getType()
      the type of the job (should match what was requested)
      Returns:
      type

    • setType

      public void setType(String type)

    • processInstanceKey

      public ActivatedJob processInstanceKey(Long processInstanceKey)

    • getProcessInstanceKey

      @Nullable public Long getProcessInstanceKey()
      the job's process instance key
      Returns:
      processInstanceKey

    • setProcessInstanceKey

      public void setProcessInstanceKey(Long processInstanceKey)

    • processDefinitionId

      public ActivatedJob processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      the bpmn process ID of the job's process definition
      Returns:
      processDefinitionId

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionVersion

      public ActivatedJob processDefinitionVersion(Integer processDefinitionVersion)

    • getProcessDefinitionVersion

      @Nullable public Integer getProcessDefinitionVersion()
      the version of the job's process definition
      Returns:
      processDefinitionVersion

    • setProcessDefinitionVersion

      public void setProcessDefinitionVersion(Integer processDefinitionVersion)

    • processDefinitionKey

      public ActivatedJob processDefinitionKey(Long processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public Long getProcessDefinitionKey()
      the key of the job's process definition
      Returns:
      processDefinitionKey

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(Long processDefinitionKey)

    • elementId

      public ActivatedJob elementId(String elementId)

    • getElementId

      @Nullable public String getElementId()
      the associated task element ID
      Returns:
      elementId

    • setElementId

      public void setElementId(String elementId)

    • elementInstanceKey

      public ActivatedJob elementInstanceKey(Long elementInstanceKey)

    • getElementInstanceKey

      @Nullable public Long getElementInstanceKey()
      the unique key identifying the associated task, unique within the scope of the process instance
      Returns:
      elementInstanceKey

    • setElementInstanceKey

      public void setElementInstanceKey(Long elementInstanceKey)

    • customHeaders

      public ActivatedJob customHeaders(Map<String,Object> customHeaders)

    • putCustomHeadersItem

      public ActivatedJob 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(Map<String,Object> customHeaders)

    • worker

      public ActivatedJob worker(String worker)

    • getWorker

      @Nullable public String getWorker()
      the name of the worker which activated this job
      Returns:
      worker

    • setWorker

      public void setWorker(String worker)

    • retries

      public ActivatedJob retries(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(Integer retries)

    • deadline

      public ActivatedJob deadline(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(Long deadline)

    • variables

      public ActivatedJob variables(Map<String,Object> variables)

    • putVariablesItem

      public ActivatedJob 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(Map<String,Object> variables)

    • tenantId

      public ActivatedJob tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The ID of the tenant that owns the job
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(String tenantId)

    • 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