public final class TaskHandle
extends java.lang.Object
implements java.io.Serializable
Queue.add(TaskOptions)
. Contains the
task name (generated if otherwise unspecified), task ETA (computed if
not specified) and queue name. The queue name and task name
uniquely identify the task for an application.Constructor and Description |
---|
TaskHandle(java.lang.String name,
java.lang.String queueName,
long etaMillis)
Deprecated.
|
TaskHandle(TaskOptions options,
java.lang.String queueName) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> |
extractParams()
Attempts to decode the
payload byte array in our options
into a list of Map.Entry |
long |
getEtaMillis()
Returns a time comparable to
System.currentTimeMillis() when
this task is scheduled for execution. |
java.lang.String |
getName()
Returns the name of this task.
|
byte[] |
getPayload()
Returns binary payload data of this task.
|
java.lang.String |
getQueueName()
Returns the name of the queue that this task was submitted into.
|
java.lang.Integer |
getRetryCount()
Returns number of leases that had been performed on this task.
|
java.lang.String |
getTag()
Returns tag of this task.
|
byte[] |
getTagAsBytes()
Returns tag of this task.
|
int |
hashCode() |
java.lang.String |
toString() |
public TaskHandle(TaskOptions options, java.lang.String queueName)
@Deprecated public TaskHandle(java.lang.String name, java.lang.String queueName, long etaMillis)
TaskHandle(TaskOptions, String)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
Queue.add()
if the name was not otherwise specified.public java.lang.String getQueueName()
public long getEtaMillis()
System.currentTimeMillis()
when
this task is scheduled for execution.public java.lang.Integer getRetryCount()
null
.public byte[] getPayload()
null
.public java.lang.String getTag() throws java.io.UnsupportedEncodingException
null
.java.io.UnsupportedEncodingException
public byte[] getTagAsBytes()
null
.public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> extractParams() throws java.io.UnsupportedEncodingException, java.lang.UnsupportedOperationException
payload
byte array in our options
into a list of Map.Entryjava.io.UnsupportedEncodingException
- if the payload cannot be decoded as a
application/x-www-form-urlencoded
string.java.lang.UnsupportedOperationException
- if the options
has no payload
or the payload bytes could not be interpreted as application/x-www-form-urlencoded
key-value pairs.