Package com.google.appengine.api.taskqueue

Class TaskHandle

java.lang.Object

com.google.appengine.api.taskqueue.TaskHandle

All Implemented Interfaces:

Serializable

public final class TaskHandle
extends Object
implements Serializable

Created from 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TaskHandle(TaskOptions options, String queueName)
TaskHandle(String name, String queueName, long etaMillis)	Deprecated. Use TaskHandle(TaskOptions, String)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<Map.Entry<String,String>>	extractParams()	Attempts to decode the payload byte array in our options into a list of Map.Entry<String, String>.
long	getEtaMillis()	Returns a time comparable to System.currentTimeMillis() when this task is scheduled for execution.
String	getName()	Returns the name of this task.
byte[]	getPayload()	Returns binary payload data of this task.
String	getQueueName()	Returns the name of the queue that this task was submitted into.
Integer	getRetryCount()	Returns number of leases that had been performed on this task.
String	getTag()	Returns tag of this task.
byte[]	getTagAsBytes()	Returns tag of this task.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskHandle

public TaskHandle(TaskOptions options,
                  String queueName)

TaskHandle

@Deprecated
public TaskHandle(String name,
                  String queueName,
                  long etaMillis)

Deprecated.

Use TaskHandle(TaskOptions, String)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Returns the name of this task. This may have been generated by a call to Queue.add() if the name was not otherwise specified.

getQueueName

public String getQueueName()

Returns the name of the queue that this task was submitted into.

getEtaMillis

public long getEtaMillis()

Returns a time comparable to System.currentTimeMillis() when this task is scheduled for execution.

getRetryCount

public Integer getRetryCount()

Returns number of leases that had been performed on this task. Can return null.

getPayload

public byte[] getPayload()

Returns binary payload data of this task. Can return null.

getTag

public String getTag()
              throws UnsupportedEncodingException

Returns tag of this task. Can return null.

Throws:

UnsupportedEncodingException

getTagAsBytes

public byte[] getTagAsBytes()

Returns tag of this task. Can return null.

extractParams

public List<Map.Entry<String,String>> extractParams()
                                                   throws UnsupportedEncodingException,
                                                          UnsupportedOperationException

Attempts to decode the payload byte array in our options into a list of Map.Entry<String, String>.

Throws:

UnsupportedEncodingException - if the payload cannot be decoded as a application/x-www-form-urlencoded string.

UnsupportedOperationException - if the options has no payload or the payload bytes could not be interpreted as application/x-www-form-urlencoded key-value pairs.