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

Class LockExternalTaskDto

java.lang.Object

org.camunda.community.rest.client.dto.LockExternalTaskDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class LockExternalTaskDto
extends Object

LockExternalTaskDto

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_LOCK_DURATION
static final String	JSON_PROPERTY_WORKER_ID

Constructor Summary

Constructors

Constructor	Description
LockExternalTaskDto()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Long	getLockDuration()	The duration to lock the external task for in milliseconds.
String	getWorkerId()	**Mandatory.** The ID of the worker who is performing the operation on the external task.
int	hashCode()
LockExternalTaskDto	lockDuration(Long lockDuration)
void	setLockDuration(Long lockDuration)
void	setWorkerId(String workerId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
LockExternalTaskDto	workerId(String workerId)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_WORKER_ID

public static final String JSON_PROPERTY_WORKER_ID

See Also:

• Constant Field Values

JSON_PROPERTY_LOCK_DURATION

public static final String JSON_PROPERTY_LOCK_DURATION

See Also:

• Constant Field Values

Constructor Details

LockExternalTaskDto

public LockExternalTaskDto()

Method Details

workerId

public LockExternalTaskDto 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)

lockDuration

public LockExternalTaskDto lockDuration(Long lockDuration)

getLockDuration

@Nullable
public Long getLockDuration()

The duration to lock the external task for in milliseconds. **Note:** Attempting to lock an already locked external task with the same `workerId` will succeed and a new lock duration will be set, starting from the current moment.

Returns:

lockDuration

setLockDuration

public void setLockDuration(Long lockDuration)

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