Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

Python 2 is no longer supported by the community. We recommend that you migrate Python 2 apps to Python 3.

google.appengine.api.queueinfo module


QueueInfo tools.

QueueInfo is a library for working with QueueInfo records, describing task queue entries for an application. QueueInfo loads the records from queue.yaml. To learn more about the parameters you can specify in queue.yaml, review the queue.yaml reference guide.


class google.appengine.api.queueinfo.Acl(**attributes)source

Bases: google.appengine.api.validation.Validated

Controls the access control list for a single task queue.

ATTRIBUTES = {u'writer_email': <google.appengine.api.validation.Optional object>, u'user_email': <google.appengine.api.validation.Optional object>}
google.appengine.api.queueinfo.LoadSingleQueue(queue_info, open_fn=None)source

Loads a queue.yaml file/string and returns a QueueInfoExternal object.

  • queue_info – The contents of a queue.yaml file, as a string.

  • open_fn – Function for opening files. Unused.


A QueueInfoExternal object.

exception google.appengine.api.queueinfo.MalformedQueueConfigurationsource

Bases: exceptions.Exception

The configuration file for the task queue is malformed.


Parses a rate string in the form number/unit, or the literal 0.

The unit is one of s (seconds), m (minutes), h (hours) or d (days).


rate – The string that contains the rate.


A floating point number that represents the rate/second.


MalformedQueueConfiguration – If the rate is invalid.


Parses a string representing the task’s age limit (maximum allowed age).

The string must be a non-negative integer or floating point number followed by one of s, m, h, or d (seconds, minutes, hours, or days, respectively).


age_limit – The string that contains the task age limit.


An integer that represents the age limit in seconds.


MalformedQueueConfiguration – If the limit argument isn’t a valid Python double followed by a required suffix.


Parses a string representing the storage bytes limit.

Optional limit suffixes are:
  • B (bytes)

  • K (kilobytes)

  • M (megabytes)

  • G (gigabytes)

  • T (terabytes)


limit – The string that specifies the storage bytes limit.


An integer that represents the storage limit in bytes.


MalformedQueueConfiguration – If the limit argument isn’t a valid Python double followed by an optional suffix.

class google.appengine.api.queueinfo.QueueEntry(**attributes)source

Bases: google.appengine.api.validation.Validated

Describes a single task queue.

ATTRIBUTES = {u'max_concurrent_requests': <google.appengine.api.validation.Optional object>, u'rate': <google.appengine.api.validation.Optional object>, u'name': u'^[A-Za-z0-9-]{0,499}$', u'target': <google.appengine.api.validation.Optional object>, u'retry_parameters': <google.appengine.api.validation.Optional object>, u'acl': <google.appengine.api.validation.Optional object>, u'bucket_size': <google.appengine.api.validation.Optional object>, u'mode': <google.appengine.api.validation.Optional object>}
class google.appengine.api.queueinfo.QueueInfoExternal(**attributes)source

Bases: google.appengine.api.validation.Validated

Describes all of the queue entries for an application.

ATTRIBUTES = {u'queue': <google.appengine.api.validation.Optional object>, 'application': <google.appengine.api.validation.Optional object>, u'total_storage_limit': <google.appengine.api.validation.Optional object>}
class google.appengine.api.queueinfo.RetryParameters(**attributes)source

Bases: google.appengine.api.validation.Validated

Specifies the retry parameters for a single task queue.

ATTRIBUTES = {u'task_retry_limit': <google.appengine.api.validation.Optional object>, u'min_backoff_seconds': <google.appengine.api.validation.Optional object>, u'task_age_limit': <google.appengine.api.validation.Optional object>, u'max_backoff_seconds': <google.appengine.api.validation.Optional object>, u'max_doublings': <google.appengine.api.validation.Optional object>}

Populates a TaskQueueRetryParameters from a queueinfo.RetryParameters.


retry – A queueinfo.RetryParameters that is read from queue.yaml that describes the queue’s retry parameters.


A taskqueue_service_pb.TaskQueueRetryParameters proto populated with the data from retry.


MalformedQueueConfiguration – If the retry parameters are invalid.