TaskQueue API v1beta2

Version: 5.3

TaskQueue API v1beta2

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you access a Google App Engine Pull Task Queue over REST. Google documentation.

(require gapi/macro)

(require-gapi-doc taskqueue.v1beta2.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 taskqueues

procedure
(taskqueue-taskqueues-get #:project project
#:taskqueue taskqueue
[ #:getStats getStats
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  taskqueue : string?
  getStats : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get detailed information about a TaskQueue.

project: The project under which the queue lies.

taskqueue: The id of the taskqueue to get the properties of.

getStats: Whether to get stats. Optional.

2.2 tasks

procedure
(taskqueue-tasks-list #:project project
#:taskqueue taskqueue
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  taskqueue : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List Tasks in a TaskQueue

project: The project under which the queue lies.

taskqueue: The id of the taskqueue to list tasks from.

procedure
(taskqueue-tasks-get #:project project
#:taskqueue taskqueue
#:task task
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  taskqueue : string?
  task : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get a particular task from a TaskQueue.

project: The project under which the queue lies.

taskqueue: The taskqueue in which the task belongs.

task: The task to get properties of.

procedure
(taskqueue-tasks-insert #:project project
#:taskqueue taskqueue
[ #:id id
#:tag tag
#:kind kind
#:enqueueTimestamp enqueueTimestamp
#:leaseTimestamp leaseTimestamp
#:payloadBase64 payloadBase64
#:queueName queueName
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  taskqueue : string?
  id : string? = 'N/A
  tag : string? = 'N/A
  kind : string? = 'N/A
  enqueueTimestamp : string? = 'N/A
  leaseTimestamp : string? = 'N/A
  payloadBase64 : string? = 'N/A
  queueName : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Insert a new task in a TaskQueue

project: The project under which the queue lies

taskqueue: The taskqueue to insert the task into

id: Name of the task.

tag: Tag for the task, could be used later to lease tasks grouped by a specific tag.

kind: The kind of object returned, in this case set to task.

enqueueTimestamp: Time (in seconds since the epoch) at which the task was enqueued.

leaseTimestamp: 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.

payloadBase64: A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.

queueName: Name of the queue that the task is in.

procedure
(taskqueue-tasks-patch #:project project
#:taskqueue taskqueue
#:task task
#:newLeaseSeconds newLeaseSeconds
[ #:id id
#:tag tag
#:kind kind
#:enqueueTimestamp enqueueTimestamp
#:leaseTimestamp leaseTimestamp
#:payloadBase64 payloadBase64
#:queueName queueName
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  taskqueue : string?
  task : string?
  newLeaseSeconds : string?
  id : string? = 'N/A
  tag : string? = 'N/A
  kind : string? = 'N/A
  enqueueTimestamp : string? = 'N/A
  leaseTimestamp : string? = 'N/A
  payloadBase64 : string? = 'N/A
  queueName : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Update tasks that are leased out of a TaskQueue. This method supports patch semantics.

project: The project under which the queue lies.

taskqueue:

task:

newLeaseSeconds: The new lease in seconds.

id: Name of the task.

tag: Tag for the task, could be used later to lease tasks grouped by a specific tag.

kind: The kind of object returned, in this case set to task.

enqueueTimestamp: Time (in seconds since the epoch) at which the task was enqueued.

leaseTimestamp: 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.

payloadBase64: A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.

queueName: Name of the queue that the task is in.

procedure
(taskqueue-tasks-lease #:project project
#:taskqueue taskqueue
#:leaseSecs leaseSecs
#:numTasks numTasks
[ #:tag tag
#:groupByTag groupByTag
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  taskqueue : string?
  leaseSecs : string?
  numTasks : string?
  tag : string? = 'N/A
  groupByTag : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Lease 1 or more tasks from a TaskQueue.

project: The project under which the queue lies.

taskqueue: The taskqueue to lease a task from.

leaseSecs: The lease in seconds.

numTasks: The number of tasks to lease.

tag: The tag allowed for tasks in the response. Must only be specified if group_by_tag is true. If group_by_tag is true and tag is not specified the tag will be that of the oldest task by eta, i.e. the first available tag

groupByTag: When true, all returned tasks will have the same tag

procedure
(taskqueue-tasks-delete #:project project
#:taskqueue taskqueue
#:task task
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  project : string?
  taskqueue : string?
  task : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Delete a task from a TaskQueue.

project: The project under which the queue lies.

taskqueue: The taskqueue to delete a task from.

task: The id of the task to delete.

procedure
(taskqueue-tasks-update #:project project
#:taskqueue taskqueue
#:task task
#:newLeaseSeconds newLeaseSeconds
[ #:id id
#:tag tag
#:kind kind
#:enqueueTimestamp enqueueTimestamp
#:leaseTimestamp leaseTimestamp
#:payloadBase64 payloadBase64
#:queueName queueName
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  project : string?
  taskqueue : string?
  task : string?
  newLeaseSeconds : string?
  id : string? = 'N/A
  tag : string? = 'N/A
  kind : string? = 'N/A
  enqueueTimestamp : string? = 'N/A
  leaseTimestamp : string? = 'N/A
  payloadBase64 : string? = 'N/A
  queueName : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Update tasks that are leased out of a TaskQueue.

project: The project under which the queue lies.

taskqueue:

task:

newLeaseSeconds: The new lease in seconds.

id: Name of the task.

tag: Tag for the task, could be used later to lease tasks grouped by a specific tag.

kind: The kind of object returned, in this case set to task.

enqueueTimestamp: Time (in seconds since the epoch) at which the task was enqueued.

leaseTimestamp: 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.

payloadBase64: A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.

queueName: Name of the queue that the task is in.