TaskQueue API . tasks

delete(project, taskqueue, task)

Delete a task from a TaskQueue.

Args:
  project: string, The project under which the queue lies. (required)
  taskqueue: string, The taskqueue to delete a task from. (required)
  task: string, The id of the task to delete. (required)

get(project, taskqueue, task)

Get a particular task from a TaskQueue.

Args:
  project: string, The project under which the queue lies. (required)
  taskqueue: string, The taskqueue in which the task belongs. (required)
  task: string, The task to get properties of. (required)

Returns:
  An object of the form:

    {
    "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
    "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
    "id": "A String", # Name of the task.
    "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
    "queueName": "A String", # Name of the queue that the task is in.
    "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
  }

lease(project, taskqueue, numTasks, leaseSecs)

Lease 1 or more tasks from a TaskQueue.

Args:
  project: string, The project under which the queue lies. (required)
  taskqueue: string, The taskqueue to lease a task from. (required)
  numTasks: integer, The number of tasks to lease. (required)
  leaseSecs: integer, The lease in seconds. (required)

Returns:
  An object of the form:

    {
    "items": [ # The actual list of tasks returned as a result of the lease operation.
      {
        "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
        "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
        "id": "A String", # Name of the task.
        "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
        "queueName": "A String", # Name of the queue that the task is in.
        "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
      },
    ],
    "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.
  }

list(project, taskqueue)

List Tasks in a TaskQueue

Args:
  project: string, The project under which the queue lies. (required)
  taskqueue: string, The id of the taskqueue to list tasks from. (required)

Returns:
  An object of the form:

    {
    "items": [ # The actual list of tasks currently active in the TaskQueue.
      {
        "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
        "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
        "id": "A String", # Name of the task.
        "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
        "queueName": "A String", # Name of the queue that the task is in.
        "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
      },
    ],
    "kind": "taskqueues#tasks", # The kind of object returned, a list of tasks.
  }