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

Class FetchExternalTaskTopicDto

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

  • Field Details

  • Constructor Details

    • FetchExternalTaskTopicDto

      public FetchExternalTaskTopicDto()

  • Method Details

    • topicName

      public FetchExternalTaskTopicDto topicName(String topicName)

    • getTopicName

      @Nonnull public String getTopicName()
      **Mandatory.** The topic's name.
      Returns:
      topicName

    • setTopicName

      public void setTopicName(String topicName)

    • lockDuration

      public FetchExternalTaskTopicDto lockDuration(Long lockDuration)

    • getLockDuration

      @Nullable public Long getLockDuration()
      **Mandatory.** The duration to lock the external tasks for in milliseconds.
      Returns:
      lockDuration

    • setLockDuration

      public void setLockDuration(Long lockDuration)

    • variables

      public FetchExternalTaskTopicDto variables(List<String> variables)

    • addVariablesItem

      public FetchExternalTaskTopicDto addVariablesItem(String variablesItem)

    • getVariables

      @Nullable public List<String> getVariables()
      A JSON array of `String` values that represent variable names. For each result task belonging to this topic, the given variables are returned as well if they are accessible from the external task's execution. If not provided - all variables will be fetched.
      Returns:
      variables

    • getVariables_JsonNullable

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

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> variables)

    • setVariables

      public void setVariables(List<String> variables)

    • localVariables

      public FetchExternalTaskTopicDto localVariables(Boolean localVariables)

    • getLocalVariables

      @Nullable public Boolean getLocalVariables()
      If `true` only local variables will be fetched.
      Returns:
      localVariables

    • getLocalVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getLocalVariables_JsonNullable()

    • setLocalVariables_JsonNullable

      public void setLocalVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> localVariables)

    • setLocalVariables

      public void setLocalVariables(Boolean localVariables)

    • businessKey

      public FetchExternalTaskTopicDto businessKey(String businessKey)

    • getBusinessKey

      @Nullable public String getBusinessKey()
      A `String` value which enables the filtering of tasks based on process instance business key.
      Returns:
      businessKey

    • getBusinessKey_JsonNullable

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

    • setBusinessKey_JsonNullable

      public void setBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> businessKey)

    • setBusinessKey

      public void setBusinessKey(String businessKey)

    • processDefinitionId

      public FetchExternalTaskTopicDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Filter tasks based on process definition id.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

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

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionIdIn

      public FetchExternalTaskTopicDto processDefinitionIdIn(List<String> processDefinitionIdIn)

    • addProcessDefinitionIdInItem

      public FetchExternalTaskTopicDto addProcessDefinitionIdInItem(String processDefinitionIdInItem)

    • getProcessDefinitionIdIn

      @Nullable public List<String> getProcessDefinitionIdIn()
      Filter tasks based on process definition ids.
      Returns:
      processDefinitionIdIn

    • getProcessDefinitionIdIn_JsonNullable

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

    • setProcessDefinitionIdIn_JsonNullable

      public void setProcessDefinitionIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processDefinitionIdIn)

    • setProcessDefinitionIdIn

      public void setProcessDefinitionIdIn(List<String> processDefinitionIdIn)

    • processDefinitionKey

      public FetchExternalTaskTopicDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Filter tasks based on process definition key.
      Returns:
      processDefinitionKey

    • getProcessDefinitionKey_JsonNullable

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

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey)

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionKeyIn

      public FetchExternalTaskTopicDto processDefinitionKeyIn(List<String> processDefinitionKeyIn)

    • addProcessDefinitionKeyInItem

      public FetchExternalTaskTopicDto addProcessDefinitionKeyInItem(String processDefinitionKeyInItem)

    • getProcessDefinitionKeyIn

      @Nullable public List<String> getProcessDefinitionKeyIn()
      Filter tasks based on process definition keys.
      Returns:
      processDefinitionKeyIn

    • getProcessDefinitionKeyIn_JsonNullable

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

    • setProcessDefinitionKeyIn_JsonNullable

      public void setProcessDefinitionKeyIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processDefinitionKeyIn)

    • setProcessDefinitionKeyIn

      public void setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)

    • processDefinitionVersionTag

      public FetchExternalTaskTopicDto processDefinitionVersionTag(String processDefinitionVersionTag)

    • getProcessDefinitionVersionTag

      @Nullable public String getProcessDefinitionVersionTag()
      Filter tasks based on process definition version tag.
      Returns:
      processDefinitionVersionTag

    • getProcessDefinitionVersionTag_JsonNullable

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

    • setProcessDefinitionVersionTag_JsonNullable

      public void setProcessDefinitionVersionTag_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionVersionTag)

    • setProcessDefinitionVersionTag

      public void setProcessDefinitionVersionTag(String processDefinitionVersionTag)

    • withoutTenantId

      public FetchExternalTaskTopicDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Filter tasks without tenant id.
      Returns:
      withoutTenantId

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withoutTenantId)

    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)

    • tenantIdIn

      public FetchExternalTaskTopicDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public FetchExternalTaskTopicDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Filter tasks based on tenant ids.
      Returns:
      tenantIdIn

    • getTenantIdIn_JsonNullable

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

    • setTenantIdIn_JsonNullable

      public void setTenantIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tenantIdIn)

    • setTenantIdIn

      public void setTenantIdIn(List<String> tenantIdIn)

    • processVariables

      public FetchExternalTaskTopicDto processVariables(Map<String,Object> processVariables)

    • putProcessVariablesItem

      public FetchExternalTaskTopicDto putProcessVariablesItem(String key, Object processVariablesItem)

    • getProcessVariables

      @Nullable public Map<String,Object> getProcessVariables()
      A `JSON` object used for filtering tasks based on process instance variable values. A property name of the object represents a process variable name, while the property value represents the process variable value to filter tasks by.
      Returns:
      processVariables

    • setProcessVariables

      public void setProcessVariables(Map<String,Object> processVariables)

    • deserializeValues

      public FetchExternalTaskTopicDto deserializeValues(Boolean deserializeValues)

    • getDeserializeValues

      @Nullable public Boolean getDeserializeValues()
      Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `false`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.
      Returns:
      deserializeValues

    • getDeserializeValues_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getDeserializeValues_JsonNullable()

    • setDeserializeValues_JsonNullable

      public void setDeserializeValues_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> deserializeValues)

    • setDeserializeValues

      public void setDeserializeValues(Boolean deserializeValues)

    • includeExtensionProperties

      public FetchExternalTaskTopicDto includeExtensionProperties(Boolean includeExtensionProperties)

    • getIncludeExtensionProperties

      @Nullable public Boolean getIncludeExtensionProperties()
      Determines whether custom extension properties defined in the BPMN activity of the external task (e.g. via the Extensions tab in the Camunda modeler) should be included in the response. Default: false
      Returns:
      includeExtensionProperties

    • getIncludeExtensionProperties_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getIncludeExtensionProperties_JsonNullable()

    • setIncludeExtensionProperties_JsonNullable

      public void setIncludeExtensionProperties_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeExtensionProperties)

    • setIncludeExtensionProperties

      public void setIncludeExtensionProperties(Boolean includeExtensionProperties)

    • 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