Package io.camunda.client.protocol.rest

Class JobActivationRequest

java.lang.Object
io.camunda.client.protocol.rest.JobActivationRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class JobActivationRequest extends Object
JobActivationRequest

  • Field Details

  • Constructor Details

    • JobActivationRequest

      public JobActivationRequest()

  • Method Details

    • type

      public JobActivationRequest type(@Nonnull String type)

    • getType

      @Nonnull public String getType()
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type=\"payment-service\" />)
      Returns:
      type

    • setType

      public void setType(@Nonnull String type)

    • worker

      public JobActivationRequest worker(@Nullable String worker)

    • getWorker

      @Nullable public String getWorker()
      The name of the worker activating the jobs, mostly used for logging purposes.
      Returns:
      worker

    • setWorker

      public void setWorker(@Nullable String worker)

    • timeout

      public JobActivationRequest timeout(@Nonnull Long timeout)

    • getTimeout

      @Nonnull public Long getTimeout()
      A job returned after this call will not be activated by another call until the timeout (in ms) has been reached.
      Returns:
      timeout

    • setTimeout

      public void setTimeout(@Nonnull Long timeout)

    • maxJobsToActivate

      public JobActivationRequest maxJobsToActivate(@Nonnull Integer maxJobsToActivate)

    • getMaxJobsToActivate

      @Nonnull public Integer getMaxJobsToActivate()
      The maximum jobs to activate by this request.
      Returns:
      maxJobsToActivate

    • setMaxJobsToActivate

      public void setMaxJobsToActivate(@Nonnull Integer maxJobsToActivate)

    • fetchVariable

      public JobActivationRequest fetchVariable(@Nullable List<String> fetchVariable)

    • addFetchVariableItem

      public JobActivationRequest addFetchVariableItem(String fetchVariableItem)

    • getFetchVariable

      @Nullable public List<String> getFetchVariable()
      A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned.
      Returns:
      fetchVariable

    • setFetchVariable

      public void setFetchVariable(@Nullable List<String> fetchVariable)

    • requestTimeout

      public JobActivationRequest requestTimeout(@Nullable Long requestTimeout)

    • getRequestTimeout

      @Nullable public Long getRequestTimeout()
      The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
      Returns:
      requestTimeout

    • setRequestTimeout

      public void setRequestTimeout(@Nullable Long requestTimeout)

    • tenantIds

      public JobActivationRequest tenantIds(@Nullable List<String> tenantIds)

    • addTenantIdsItem

      public JobActivationRequest addTenantIdsItem(String tenantIdsItem)

    • getTenantIds

      @Nullable public List<String> getTenantIds()
      A list of IDs of tenants for which to activate jobs.
      Returns:
      tenantIds

    • setTenantIds

      public void setTenantIds(@Nullable List<String> tenantIds)

    • tenantFilter

      public JobActivationRequest tenantFilter(@Nullable TenantFilterEnum tenantFilter)

    • getTenantFilter

      @Nullable public TenantFilterEnum getTenantFilter()
      The tenant filtering strategy - determines whether to use provided tenant IDs or assigned tenant IDs from the authenticated principal's authorized tenants.
      Returns:
      tenantFilter

    • setTenantFilter

      public void setTenantFilter(@Nullable TenantFilterEnum tenantFilter)

    • withLease

      public JobActivationRequest withLease(@Nullable Boolean withLease)

    • getWithLease

      @Nullable public Boolean getWithLease()
      Whether to activate the jobs with a lease. When true, each activated job is assigned a distinct, opaque lease token, returned as ActivatedJobResult.leaseToken. The lease fences the complete, fail, and throw-error commands against a superseded activation of the same job (for example, after the job timed out or failed and was re-activated by another worker): a command carrying a stale lease token is rejected rather than racing with the newer activation. Once a job has been activated with a lease, it is served only to leasing workers of that job type; a homogeneous fleet per job type is recommended. Omit or set to false to activate jobs without a lease.
      Returns:
      withLease

    • setWithLease

      public void setWithLease(@Nullable Boolean withLease)

    • 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