org.openapitools.client.model

Class FetchExternalTaskTopicDto

java.lang.Object

org.openapitools.client.model.FetchExternalTaskTopicDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-04-27T12:13:44.667+02:00[Europe/Berlin]")
public class FetchExternalTaskTopicDto
extends Object

FetchExternalTaskTopicDto

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_BUSINESS_KEY
static String	SERIALIZED_NAME_DESERIALIZE_VALUES
static String	SERIALIZED_NAME_INCLUDE_EXTENSION_PROPERTIES
static String	SERIALIZED_NAME_LOCAL_VARIABLES
static String	SERIALIZED_NAME_LOCK_DURATION
static String	SERIALIZED_NAME_PROCESS_DEFINITION_ID
static String	SERIALIZED_NAME_PROCESS_DEFINITION_ID_IN
static String	SERIALIZED_NAME_PROCESS_DEFINITION_KEY
static String	SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN
static String	SERIALIZED_NAME_PROCESS_DEFINITION_VERSION_TAG
static String	SERIALIZED_NAME_PROCESS_VARIABLES
static String	SERIALIZED_NAME_TENANT_ID_IN
static String	SERIALIZED_NAME_TOPIC_NAME
static String	SERIALIZED_NAME_VARIABLES
static String	SERIALIZED_NAME_WITHOUT_TENANT_ID

Constructor Summary

Constructors

Constructor and Description
FetchExternalTaskTopicDto()

Method Summary

Modifier and Type	Method and Description
FetchExternalTaskTopicDto	addProcessDefinitionIdInItem(String processDefinitionIdInItem)
FetchExternalTaskTopicDto	addProcessDefinitionKeyInItem(String processDefinitionKeyInItem)
FetchExternalTaskTopicDto	addTenantIdInItem(String tenantIdInItem)
FetchExternalTaskTopicDto	addVariablesItem(String variablesItem)
FetchExternalTaskTopicDto	businessKey(String businessKey)
FetchExternalTaskTopicDto	deserializeValues(Boolean deserializeValues)
boolean	equals(Object o)
String	getBusinessKey() A `String` value which enables the filtering of tasks based on process instance business key.
Boolean	getDeserializeValues() Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `false`).
Boolean	getIncludeExtensionProperties() Determines whether custom extension properties defined in the BPMN activity of the external task (e.g.
Boolean	getLocalVariables() If `true` only local variables will be fetched.
Long	getLockDuration() **Mandatory.** The duration to lock the external tasks for in milliseconds.
String	getProcessDefinitionId() Filter tasks based on process definition id.
List<String>	getProcessDefinitionIdIn() Filter tasks based on process definition ids.
String	getProcessDefinitionKey() Filter tasks based on process definition key.
List<String>	getProcessDefinitionKeyIn() Filter tasks based on process definition keys.
String	getProcessDefinitionVersionTag() Filter tasks based on process definition version tag.
Map<String,Object>	getProcessVariables() A `JSON` object used for filtering tasks based on process instance variable values.
List<String>	getTenantIdIn() Filter tasks based on tenant ids.
String	getTopicName() **Mandatory.** The topic's name.
List<String>	getVariables() A JSON array of `String` values that represent variable names.
Boolean	getWithoutTenantId() Filter tasks without tenant id.
int	hashCode()
FetchExternalTaskTopicDto	includeExtensionProperties(Boolean includeExtensionProperties)
FetchExternalTaskTopicDto	localVariables(Boolean localVariables)
FetchExternalTaskTopicDto	lockDuration(Long lockDuration)
FetchExternalTaskTopicDto	processDefinitionId(String processDefinitionId)
FetchExternalTaskTopicDto	processDefinitionIdIn(List<String> processDefinitionIdIn)
FetchExternalTaskTopicDto	processDefinitionKey(String processDefinitionKey)
FetchExternalTaskTopicDto	processDefinitionKeyIn(List<String> processDefinitionKeyIn)
FetchExternalTaskTopicDto	processDefinitionVersionTag(String processDefinitionVersionTag)
FetchExternalTaskTopicDto	processVariables(Map<String,Object> processVariables)
FetchExternalTaskTopicDto	putProcessVariablesItem(String key, Object processVariablesItem)
void	setBusinessKey(String businessKey)
void	setDeserializeValues(Boolean deserializeValues)
void	setIncludeExtensionProperties(Boolean includeExtensionProperties)
void	setLocalVariables(Boolean localVariables)
void	setLockDuration(Long lockDuration)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionIdIn(List<String> processDefinitionIdIn)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)
void	setProcessDefinitionVersionTag(String processDefinitionVersionTag)
void	setProcessVariables(Map<String,Object> processVariables)
void	setTenantIdIn(List<String> tenantIdIn)
void	setTopicName(String topicName)
void	setVariables(List<String> variables)
void	setWithoutTenantId(Boolean withoutTenantId)
FetchExternalTaskTopicDto	tenantIdIn(List<String> tenantIdIn)
FetchExternalTaskTopicDto	topicName(String topicName)
String	toString()
FetchExternalTaskTopicDto	variables(List<String> variables)
FetchExternalTaskTopicDto	withoutTenantId(Boolean withoutTenantId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_TOPIC_NAME

public static final String SERIALIZED_NAME_TOPIC_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_LOCK_DURATION

public static final String SERIALIZED_NAME_LOCK_DURATION

See Also:

Constant Field Values

SERIALIZED_NAME_VARIABLES

public static final String SERIALIZED_NAME_VARIABLES

See Also:

Constant Field Values

SERIALIZED_NAME_LOCAL_VARIABLES

public static final String SERIALIZED_NAME_LOCAL_VARIABLES

See Also:

Constant Field Values

SERIALIZED_NAME_BUSINESS_KEY

public static final String SERIALIZED_NAME_BUSINESS_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID_IN

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY_IN

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_VERSION_TAG

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_VERSION_TAG

See Also:

Constant Field Values

SERIALIZED_NAME_WITHOUT_TENANT_ID

public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TENANT_ID_IN

public static final String SERIALIZED_NAME_TENANT_ID_IN

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_VARIABLES

public static final String SERIALIZED_NAME_PROCESS_VARIABLES

See Also:

Constant Field Values

SERIALIZED_NAME_DESERIALIZE_VALUES

public static final String SERIALIZED_NAME_DESERIALIZE_VALUES

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_EXTENSION_PROPERTIES

public static final String SERIALIZED_NAME_INCLUDE_EXTENSION_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

FetchExternalTaskTopicDto

public FetchExternalTaskTopicDto()

Method Detail

topicName

public FetchExternalTaskTopicDto topicName(String topicName)

getTopicName

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

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

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

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

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

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

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

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

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(String processDefinitionVersionTag)

withoutTenantId

public FetchExternalTaskTopicDto withoutTenantId(Boolean withoutTenantId)

getWithoutTenantId

@Nullable
public Boolean getWithoutTenantId()

Filter tasks without tenant id.

Returns:

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

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

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

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