Package org.openapitools.client.model

Class FetchExternalTaskTopicDto

  • public class FetchExternalTaskTopicDto
extends Object
    FetchExternalTaskTopicDto

    • Constructor Detail

      • FetchExternalTaskTopicDto

        public FetchExternalTaskTopicDto()

    • Method Detail

      • getTopicName

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

      • setTopicName

        public void setTopicName​(String topicName)

      • getLockDuration

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

      • setLockDuration

        public void setLockDuration​(Long lockDuration)

      • getVariables

        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

      • setVariables

        public void setVariables​(List<String> variables)

      • getLocalVariables

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

      • setLocalVariables

        public void setLocalVariables​(Boolean localVariables)

      • getBusinessKey

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

      • setBusinessKey

        public void setBusinessKey​(String businessKey)

      • getProcessDefinitionId

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

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionIdIn

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

      • setProcessDefinitionIdIn

        public void setProcessDefinitionIdIn​(List<String> processDefinitionIdIn)

      • getProcessDefinitionKey

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

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getProcessDefinitionKeyIn

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

      • setProcessDefinitionKeyIn

        public void setProcessDefinitionKeyIn​(List<String> processDefinitionKeyIn)

      • getProcessDefinitionVersionTag

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

      • setProcessDefinitionVersionTag

        public void setProcessDefinitionVersionTag​(String processDefinitionVersionTag)

      • getWithoutTenantId

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

      • setWithoutTenantId

        public void setWithoutTenantId​(Boolean withoutTenantId)

      • getTenantIdIn

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

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getProcessVariables

        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)

      • getDeserializeValues

        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

      • setDeserializeValues

        public void setDeserializeValues​(Boolean deserializeValues)

      • getIncludeExtensionProperties

        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

      • setIncludeExtensionProperties

        public void setIncludeExtensionProperties​(Boolean includeExtensionProperties)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object