Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
Stay organized with collections
Save and categorize content based on your preferences.
google.appengine.api.queueinfo module
Summary
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.
Contents
- 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.
Parameters
-
queue_info – The contents of a queue.yaml file, as a string.
-
open_fn – Function for opening files. Unused.
ReturnsA QueueInfoExternal object.
- google.appengine.api.queueinfo.ParseRate(rate)source
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).
Parametersrate – The string that contains the rate.
ReturnsA floating point number that represents the rate/second.
RaisesMalformedQueueConfiguration – If the rate is invalid.
- google.appengine.api.queueinfo.ParseTaskAgeLimit(age_limit)source
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).
Parametersage_limit – The string that contains the task age limit.
ReturnsAn integer that represents the age limit in seconds.
RaisesMalformedQueueConfiguration – If the limit argument isn’t a valid Python
double followed by a required suffix.
- google.appengine.api.queueinfo.ParseTotalStorageLimit(limit)source
Parses a string representing the storage bytes limit.
- Optional limit suffixes are:
-
-
B (bytes)
-
K (kilobytes)
-
M (megabytes)
-
G (gigabytes)
-
T (terabytes)
Parameterslimit – The string that specifies the storage bytes limit.
ReturnsAn integer that represents the storage limit in bytes.
RaisesMalformedQueueConfiguration – 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>}
- google.appengine.api.queueinfo.TranslateRetryParameters(retry)source
Populates a TaskQueueRetryParameters from a queueinfo.RetryParameters.
Parametersretry – A queueinfo.RetryParameters that is read from queue.yaml that
describes the queue’s retry parameters.
ReturnsA taskqueue_service_pb.TaskQueueRetryParameters proto populated with the
data from retry.
RaisesMalformedQueueConfiguration – If the retry parameters are invalid.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003egoogle.appengine.api.queueinfo\u003c/code\u003e module provides tools for managing task queue entries described in the \u003ccode\u003equeue.yaml\u003c/code\u003e file.\u003c/p\u003e\n"],["\u003cp\u003eThe module includes classes like \u003ccode\u003eAcl\u003c/code\u003e, \u003ccode\u003eQueueEntry\u003c/code\u003e, \u003ccode\u003eQueueInfoExternal\u003c/code\u003e, and \u003ccode\u003eRetryParameters\u003c/code\u003e to define and configure different aspects of task queues.\u003c/p\u003e\n"],["\u003cp\u003eFunctions such as \u003ccode\u003eLoadSingleQueue\u003c/code\u003e, \u003ccode\u003eParseRate\u003c/code\u003e, \u003ccode\u003eParseTaskAgeLimit\u003c/code\u003e, and \u003ccode\u003eParseTotalStorageLimit\u003c/code\u003e allow for loading queue configurations, parsing rate strings, parsing task age limits, and parsing storage limit strings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eMalformedQueueConfiguration\u003c/code\u003e is an exception raised when the task queue configuration file is invalid.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eTranslateRetryParameters\u003c/code\u003e is a function used to translate retry parameters from \u003ccode\u003equeueinfo.RetryParameters\u003c/code\u003e to a \u003ccode\u003etaskqueue_service_pb.TaskQueueRetryParameters\u003c/code\u003e proto, while also validating the retry configuration.\u003c/p\u003e\n"]]],[],null,["# google.appengine.api.queueinfo module\n=====================================\n\nSummary\n-------\n\nQueueInfo tools.\n\nQueueInfo is a library for working with QueueInfo records, describing task queue\nentries for an application. QueueInfo loads the records from `queue.yaml`. To\nlearn more about the parameters you can specify in `queue.yaml`, review the\n[queue.yaml reference guide](https://cloud.google.com/appengine/docs/python/config/queueref).\n\nContents\n--------\n\n*class* google.appengine.api.queueinfo.Acl(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#Acl)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n Controls the access control list for a single task queue. \n\n ATTRIBUTES*= {u'writer_email': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'user_email': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n: \n\ngoogle.appengine.api.queueinfo.LoadSingleQueue(queue_info, open_fn=None)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#LoadSingleQueue)\n\n: Loads a `queue.yaml` file/string and returns a `QueueInfoExternal` object.\n\n Parameters\n\n - queue_info -- The contents of a `queue.yaml` file, as a string.\n\n - open_fn -- Function for opening files. Unused.\n\n Returns\n\nA `QueueInfoExternal` object. \n\n*exception* google.appengine.api.queueinfo.MalformedQueueConfiguration[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#MalformedQueueConfiguration)\n\n: Bases: exceptions.Exception\n\nThe configuration file for the task queue is malformed. \n\ngoogle.appengine.api.queueinfo.ParseRate(rate)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#ParseRate)\n\n: Parses a rate string in the form `number/unit`, or the literal `0`.\n\n The unit is one of `s` (seconds), `m` (minutes), `h` (hours) or `d` (days).\n Parameters\n\n rate -- The string that contains the rate.\n Returns\n\n A floating point number that represents the `rate/second`.\n Raises\n\n[MalformedQueueConfiguration](#google.appengine.api.queueinfo.MalformedQueueConfiguration) -- If the rate is invalid. \n\ngoogle.appengine.api.queueinfo.ParseTaskAgeLimit(age_limit)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#ParseTaskAgeLimit)\n\n: Parses a string representing the task's age limit (maximum allowed age).\n\n The string must be a non-negative integer or floating point number followed by\n one of `s`, `m`, `h`, or `d` (seconds, minutes, hours, or days, respectively).\n Parameters\n\n age_limit -- The string that contains the task age limit.\n Returns\n\n An integer that represents the age limit in seconds.\n Raises\n\n [MalformedQueueConfiguration](#google.appengine.api.queueinfo.MalformedQueueConfiguration) -- If the limit argument isn't a valid Python\ndouble followed by a required suffix. \n\ngoogle.appengine.api.queueinfo.ParseTotalStorageLimit(limit)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#ParseTotalStorageLimit)\n\n: Parses a string representing the storage bytes limit.\n\n Optional limit suffixes are:\n :\n - `B` (bytes)\n\n - `K` (kilobytes)\n\n - `M` (megabytes)\n\n - `G` (gigabytes)\n\n - `T` (terabytes)\n\n\n Parameters\n\n limit -- The string that specifies the storage bytes limit.\n Returns\n\n An integer that represents the storage limit in bytes.\n Raises\n\n [MalformedQueueConfiguration](#google.appengine.api.queueinfo.MalformedQueueConfiguration) -- If the limit argument isn't a valid Python\ndouble followed by an optional suffix. \n\n*class* google.appengine.api.queueinfo.QueueEntry(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#QueueEntry)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n Describes a single task queue. \n\n ATTRIBUTES*= {u'max_concurrent_requests': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'rate': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'name': u'\\^\\[A-Za-z0-9-\\]{0,499}$', u'target': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'retry_parameters': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'acl': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'bucket_size': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'mode': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n: \n\n*class* google.appengine.api.queueinfo.QueueInfoExternal(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#QueueInfoExternal)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n Describes all of the queue entries for an application. \n\n ATTRIBUTES*= {u'queue': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'application': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'total_storage_limit': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n: \n\n*class* google.appengine.api.queueinfo.RetryParameters(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#RetryParameters)\n\n: Bases: [google.appengine.api.validation.Validated](/appengine/docs/legacy/standard/python/refdocs/google.appengine.api.validation#google.appengine.api.validation.Validated)\n\n Specifies the retry parameters for a single task queue. \n\n ATTRIBUTES*= {u'task_retry_limit': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'min_backoff_seconds': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'task_age_limit': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'max_backoff_seconds': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, u'max_doublings': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n: \n\ngoogle.appengine.api.queueinfo.TranslateRetryParameters(retry)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/queueinfo#TranslateRetryParameters)\n\n: Populates a `TaskQueueRetryParameters` from a `queueinfo.RetryParameters`.\n\n Parameters\n\n retry -- A `queueinfo.RetryParameters` that is read from `queue.yaml` that\n describes the queue's retry parameters.\n Returns\n\n A `taskqueue_service_pb.TaskQueueRetryParameters` proto populated with the\n data from `retry`.\n Raises\n\n [MalformedQueueConfiguration](#google.appengine.api.queueinfo.MalformedQueueConfiguration) -- If the retry parameters are invalid."]]
