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.backendinfo module
Summary
A library for working with BackendInfoExternal records, describing backends
configured for an application. Supports loading the records from backend.yaml.
Contents
- class google.appengine.api.backendinfo.BackendEntry(*args, **kwargs)source
-
Bases: google.appengine.api.validation.Validated
A backend entry describes a single backend.
- ATTRIBUTES = {'max_concurrent_requests': <google.appengine.api.validation.Optional object>, 'instances': <google.appengine.api.validation.Optional object>, 'state': <google.appengine.api.validation.Optional object>, 'name': '(?!-)[a-z\\d\\-]{1,100}', 'start': <google.appengine.api.validation.Optional object>, 'public': <google.appengine.api.validation.Optional object>, 'dynamic': <google.appengine.api.validation.Optional object>, 'class': <google.appengine.api.validation.Optional object>, 'failfast': <google.appengine.api.validation.Optional object>, 'options': <google.appengine.api.validation.Optional object>}
- ParseOptions()source
-
Parses the ‘options’ field and sets appropriate fields.
- ToDict()source
-
Returns a sorted dictionary representing the backend entry.
- WriteOptions()source
-
Writes the ‘options’ field based on other settings.
- get_class()source
-
Accessor for ‘class’, since an attribute reference is an error.
- set_class(Class)source
-
Setter for ‘class’, since an attribute reference is an error.
- class google.appengine.api.backendinfo.BackendInfoExternal(**attributes)source
-
Bases: google.appengine.api.validation.Validated
BackendInfoExternal describes all backend entries for an application.
- ATTRIBUTES = {'backends': <google.appengine.api.validation.Optional object>}
- exception google.appengine.api.backendinfo.BadConfigsource
-
Bases: exceptions.Exception
An invalid configuration was provided.
- google.appengine.api.backendinfo.LoadBackendEntry(backend_entry)source
Parses a BackendEntry object from a string.
Parametersbackend_entry – a backend entry, as a string
ReturnsA BackendEntry object.
- google.appengine.api.backendinfo.LoadBackendInfo(backend_info, open_fn=None)source
Parses a BackendInfoExternal object from a string.
ParametersReturnsA BackendInfoExternal object.
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.backendinfo\u003c/code\u003e module provides tools for managing \u003ccode\u003eBackendInfoExternal\u003c/code\u003e records, which define the configuration of backends for an application.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBackendEntry\u003c/code\u003e is a class representing a single backend, with attributes like name, instances, state, and options, while also containing methods such as ParseOptions, ToDict, and WriteOptions.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBackendInfoExternal\u003c/code\u003e is a class that encapsulates all backend entries for a specific application, essentially serving as a collection of \u003ccode\u003eBackendEntry\u003c/code\u003e instances.\u003c/p\u003e\n"],["\u003cp\u003eThe module includes functions \u003ccode\u003eLoadBackendEntry\u003c/code\u003e and \u003ccode\u003eLoadBackendInfo\u003c/code\u003e for parsing backend configurations from strings into \u003ccode\u003eBackendEntry\u003c/code\u003e and \u003ccode\u003eBackendInfoExternal\u003c/code\u003e objects respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBadConfig\u003c/code\u003e exception is raised when the provided configuration is invalid, ensuring that there is a way to handle errors in config.\u003c/p\u003e\n"]]],[],null,["# google.appengine.api.backendinfo module\n=======================================\n\nSummary\n-------\n\nA library for working with BackendInfoExternal records, describing backends\nconfigured for an application. Supports loading the records from backend.yaml.\n\nContents\n--------\n\n*class* google.appengine.api.backendinfo.BackendEntry(\\*args, \\*\\*kwargs)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry)\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 A backend entry describes a single backend. \n\n ATTRIBUTES*= {'max_concurrent_requests': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'instances': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'state': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'name': '(?!-)\\[a-z\\\\\\\\d\\\\\\\\-\\]{1,100}', 'start': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'public': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'dynamic': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'class': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'failfast': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e, 'options': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n : \n\n Init()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.Init)\n : \n\n ParseOptions()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.ParseOptions)\n\n : Parses the 'options' field and sets appropriate fields.\n\n ToDict()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.ToDict)\n\n : Returns a sorted dictionary representing the backend entry.\n\n WriteOptions()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.WriteOptions)\n\n : Writes the 'options' field based on other settings.\n\n get_class()[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.get_class)\n\n : Accessor for 'class', since an attribute reference is an error.\n\n set_class(Class)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendEntry.set_class)\n\n : Setter for 'class', since an attribute reference is an error.\n\n*class* google.appengine.api.backendinfo.BackendInfoExternal(\\*\\*attributes)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BackendInfoExternal)\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 BackendInfoExternal describes all backend entries for an application. \n\n ATTRIBUTES*= {'backends': \\\u003cgoogle.appengine.api.validation.Optional object\\\u003e}*\n: \n\n*exception* google.appengine.api.backendinfo.BadConfig[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#BadConfig)\n\n: Bases: exceptions.Exception\n\nAn invalid configuration was provided. \n\ngoogle.appengine.api.backendinfo.LoadBackendEntry(backend_entry)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#LoadBackendEntry)\n\n: Parses a BackendEntry object from a string.\n\n Parameters\n\n backend_entry -- a backend entry, as a string\n Returns\n\nA BackendEntry object. \n\ngoogle.appengine.api.backendinfo.LoadBackendInfo(backend_info, open_fn=None)[source](/appengine/docs/legacy/standard/python/refdocs/modules/google/appengine/api/backendinfo#LoadBackendInfo)\n\n: Parses a BackendInfoExternal object from a string.\n\n Parameters\n\n - backend_info -- a backends stanza (list of backends) as a string\n\n - open_fn -- Function for opening files. Unused.\n\n Returns\n\n A BackendInfoExternal object."]]
