ReceivedTask (Nitric Java SDK 0.12.3 API)

java.lang.Object
- io.nitric.api.queue.Task
- - io.nitric.api.queue.ReceivedTask

```
public class ReceivedTask
extends Task
```
Provides a Queue API Received Task class.

See Also:

Task

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ReceivedTask.ReceivedTaskBuilder
Provides a ReceivedTask builder class.
- Nested classes/interfaces inherited from class io.nitric.api.queue.Task
  Task.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`complete()`	Complete the received task using its lease id.
`String`	`getLeaseId()`	Return the lease id unique to the pop request, this is used to complete, extend the lease or release the task.
`String`	`getQueue()`	Return the name of the received task queue.
`static ReceivedTask.ReceivedTaskBuilder`	`newReceivedTaskBuilder()`	Return a new ReceivedTask builder.
`String`	`toString()`	Return the string representation of this object.

Methods inherited from class io.nitric.api.queue.Task
getId, getPayload, getPayloadType, newBuilder

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

- Method Detail
  - getLeaseId
```
public String getLeaseId()
```
    Return the lease id unique to the pop request, this is used to complete, extend the lease or release the task.
    
    Returns:
    
    the task lease id, unique to the pop request.
  - getQueue
```
public String getQueue()
```
    Return the name of the received task queue.
    
    Returns:
    
    the name of the received task queue.
  - complete
```
public void complete()
              throws NitricException
```
    Complete the received task using its lease id.
    
    Throws:
    
    NitricException - if a Queue Service API error occurs
  - newReceivedTaskBuilder
```
public static ReceivedTask.ReceivedTaskBuilder newReceivedTaskBuilder()
```
    Return a new ReceivedTask builder.
    
    Returns:
    
    a new ReceivedTask builder
  - toString
```
public String toString()
```
    Return the string representation of this object.
    
    Overrides:
    
    toString in class Task
    
    Returns:
    
    the string representation of this object