Package org.camunda.community.rest.client.dto

Class ExternalTaskFailureDto

java.lang.Object
org.camunda.community.rest.client.dto.ExternalTaskFailureDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class ExternalTaskFailureDto extends Object
ExternalTaskFailureDto

  • Field Details

  • Constructor Details

    • ExternalTaskFailureDto

      public ExternalTaskFailureDto()

  • Method Details

    • workerId

      public ExternalTaskFailureDto workerId(String workerId)

    • getWorkerId

      @Nullable public String getWorkerId()
      **Mandatory.** The ID of the worker who is performing the operation on the external task. If the task is already locked, must match the id of the worker who has most recently locked the task.
      Returns:
      workerId

    • setWorkerId

      public void setWorkerId(String workerId)

    • errorMessage

      public ExternalTaskFailureDto errorMessage(String errorMessage)

    • getErrorMessage

      @Nullable public String getErrorMessage()
      An message indicating the reason of the failure.
      Returns:
      errorMessage

    • getErrorMessage_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getErrorMessage_JsonNullable()

    • setErrorMessage_JsonNullable

      public void setErrorMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> errorMessage)

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

    • errorDetails

      public ExternalTaskFailureDto errorDetails(String errorDetails)

    • getErrorDetails

      @Nullable public String getErrorDetails()
      A detailed error description.
      Returns:
      errorDetails

    • getErrorDetails_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getErrorDetails_JsonNullable()

    • setErrorDetails_JsonNullable

      public void setErrorDetails_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> errorDetails)

    • setErrorDetails

      public void setErrorDetails(String errorDetails)

    • retries

      public ExternalTaskFailureDto retries(Integer retries)

    • getRetries

      @Nullable public Integer getRetries()
      A number of how often the task should be retried. Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the `errorMessage` parameter.
      Returns:
      retries

    • getRetries_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Integer> getRetries_JsonNullable()

    • setRetries_JsonNullable

      public void setRetries_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> retries)

    • setRetries

      public void setRetries(Integer retries)

    • retryTimeout

      public ExternalTaskFailureDto retryTimeout(Long retryTimeout)

    • getRetryTimeout

      @Nullable public Long getRetryTimeout()
      A timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.
      Returns:
      retryTimeout

    • getRetryTimeout_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Long> getRetryTimeout_JsonNullable()

    • setRetryTimeout_JsonNullable

      public void setRetryTimeout_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> retryTimeout)

    • setRetryTimeout

      public void setRetryTimeout(Long retryTimeout)

    • variables

      public ExternalTaskFailureDto variables(Map<String,VariableValueDto> variables)

    • putVariablesItem

      public ExternalTaskFailureDto putVariablesItem(String key, VariableValueDto variablesItem)

    • getVariables

      @Nullable public Map<String,VariableValueDto> getVariables()
      A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:
      Returns:
      variables

    • getVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> getVariables_JsonNullable()

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> variables)

    • setVariables

      public void setVariables(Map<String,VariableValueDto> variables)

    • localVariables

      public ExternalTaskFailureDto localVariables(Map<String,VariableValueDto> localVariables)

    • putLocalVariablesItem

      public ExternalTaskFailureDto putLocalVariablesItem(String key, VariableValueDto localVariablesItem)

    • getLocalVariables

      @Nullable public Map<String,VariableValueDto> getLocalVariables()
      A JSON object containing local variable key-value pairs. Local variables are set only in the scope of external task. Each key is a variable name and each value a JSON variable value object with the following properties:
      Returns:
      localVariables

    • getLocalVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> getLocalVariables_JsonNullable()

    • setLocalVariables_JsonNullable

      public void setLocalVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> localVariables)

    • setLocalVariables

      public void setLocalVariables(Map<String,VariableValueDto> localVariables)

    • 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