FetchExternalTasksDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.FetchExternalTasksDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class FetchExternalTasksDto
extends Object

FetchExternalTasksDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ASYNC_RESPONSE_TIMEOUT`
`static String`	`SERIALIZED_NAME_MAX_TASKS`
`static String`	`SERIALIZED_NAME_TOPICS`
`static String`	`SERIALIZED_NAME_USE_PRIORITY`
`static String`	`SERIALIZED_NAME_WORKER_ID`

Constructor Summary

Constructors
Constructor and Description

FetchExternalTasksDto()

Constructors
Constructor and Description
`FetchExternalTasksDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FetchExternalTasksDto`	`addTopicsItem(FetchExternalTaskTopicDto topicsItem)`
`FetchExternalTasksDto`	`asyncResponseTimeout(Long asyncResponseTimeout)`
`boolean`	`equals(Object o)`
`Long`	`getAsyncResponseTimeout()` The [Long Polling](https://docs.camunda.org/manual/7.15/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) timeout in milliseconds.
`Integer`	`getMaxTasks()` Mandatory. The maximum number of tasks to return.
`List<FetchExternalTaskTopicDto>`	`getTopics()` A JSON array of topic objects for which external tasks should be fetched.
`Boolean`	`getUsePriority()` A `boolean` value, which indicates whether the task should be fetched based on its priority or arbitrarily.
`String`	`getWorkerId()` Mandatory. The id of the worker on which behalf tasks are fetched.
`int`	`hashCode()`
`FetchExternalTasksDto`	`maxTasks(Integer maxTasks)`
`void`	`setAsyncResponseTimeout(Long asyncResponseTimeout)`
`void`	`setMaxTasks(Integer maxTasks)`
`void`	`setTopics(List<FetchExternalTaskTopicDto> topics)`
`void`	`setUsePriority(Boolean usePriority)`
`void`	`setWorkerId(String workerId)`
`FetchExternalTasksDto`	`topics(List<FetchExternalTaskTopicDto> topics)`
`String`	`toString()`
`FetchExternalTasksDto`	`usePriority(Boolean usePriority)`
`FetchExternalTasksDto`	`workerId(String workerId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_WORKER_ID
```
public static final String SERIALIZED_NAME_WORKER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MAX_TASKS
```
public static final String SERIALIZED_NAME_MAX_TASKS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_PRIORITY
```
public static final String SERIALIZED_NAME_USE_PRIORITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ASYNC_RESPONSE_TIMEOUT
```
public static final String SERIALIZED_NAME_ASYNC_RESPONSE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOPICS
```
public static final String SERIALIZED_NAME_TOPICS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FetchExternalTasksDto
```
public FetchExternalTasksDto()
```
- Method Detail
  - workerId
```
public FetchExternalTasksDto workerId(String workerId)
```
  - getWorkerId
```
public String getWorkerId()
```
    **Mandatory.** The id of the worker on which behalf tasks are fetched. The returned tasks are locked for that worker and can only be completed when providing the same worker id.
    
    Returns:
    
    workerId
  - setWorkerId
```
public void setWorkerId(String workerId)
```
  - maxTasks
```
public FetchExternalTasksDto maxTasks(Integer maxTasks)
```
  - getMaxTasks
```
@Nullable
public Integer getMaxTasks()
```
    **Mandatory.** The maximum number of tasks to return.
    
    Returns:
    
    maxTasks
  - setMaxTasks
```
public void setMaxTasks(Integer maxTasks)
```
  - usePriority
```
public FetchExternalTasksDto usePriority(Boolean usePriority)
```
  - getUsePriority
```
@Nullable
public Boolean getUsePriority()
```
    A `boolean` value, which indicates whether the task should be fetched based on its priority or arbitrarily.
    
    Returns:
    
    usePriority
  - setUsePriority
```
public void setUsePriority(Boolean usePriority)
```
  - asyncResponseTimeout
```
public FetchExternalTasksDto asyncResponseTimeout(Long asyncResponseTimeout)
```
  - getAsyncResponseTimeout
```
@Nullable
public Long getAsyncResponseTimeout()
```
    The [Long Polling](https://docs.camunda.org/manual/7.15/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) timeout in milliseconds. **Note:** The value cannot be set larger than 1.800.000 milliseconds (corresponds to 30 minutes).
    
    Returns:
    
    asyncResponseTimeout
  - setAsyncResponseTimeout
```
public void setAsyncResponseTimeout(Long asyncResponseTimeout)
```
  - topics
```
public FetchExternalTasksDto topics(List<FetchExternalTaskTopicDto> topics)
```
  - addTopicsItem
```
public FetchExternalTasksDto addTopicsItem(FetchExternalTaskTopicDto topicsItem)
```
  - getTopics
```
@Nullable
public List<FetchExternalTaskTopicDto> getTopics()
```
    A JSON array of topic objects for which external tasks should be fetched. The returned tasks may be arbitrarily distributed among these topics. Each topic object has the following properties:
    
    Returns:
    
    topics
  - setTopics
```
public void setTopics(List<FetchExternalTaskTopicDto> topics)
```
  - 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

Class FetchExternalTasksDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_WORKER_ID

SERIALIZED_NAME_MAX_TASKS

SERIALIZED_NAME_USE_PRIORITY

SERIALIZED_NAME_ASYNC_RESPONSE_TIMEOUT

SERIALIZED_NAME_TOPICS

Constructor Detail

FetchExternalTasksDto

Method Detail

workerId

getWorkerId

setWorkerId

maxTasks

getMaxTasks

setMaxTasks

usePriority

getUsePriority

setUsePriority

asyncResponseTimeout

getAsyncResponseTimeout

setAsyncResponseTimeout

topics

addTopicsItem

getTopics

setTopics

equals

hashCode

toString