google.appengine.api.prospective_search.prospective_search_admin module


ProspectiveSearch Admin API.

Admin functions (private to this module) for prospective search.

Functions defined in this module:

list_subscriptions: Lists subscriptions, for a specified app_id and topic. list_topics: Lists topics that have subscriptions, for a specified app_id.


google.appengine.api.prospective_search.prospective_search_admin.list_subscriptions(topic, max_results, app_id=None, sub_id_start=None, expires_before=None)source

List subscriptions on a topic.

  • topic -- required for datastore.Entity document_class, optional for db.Model.

  • max_results -- maximum number of subscriptions to return.

  • app_id -- if not None, use this app_id.

  • sub_id_start -- return only subscriptions that are lexicographically equal or greater than the specified value.

  • expires_before -- when set, limits list to subscriptions which will expire no later than expires_before (epoch time).


subscription id query expiration time (secs after the Unix epoch when subscription expires) state (SubscriptionState = OK/PENDING/ERROR) error_message (if state is ERROR)

Return type

List of subscription tuples. The subscription tuple contains

  • DocumentTypeError -- document type is unsupported.

  • TopicNotSpecified -- raised for datastore.Entity if topic is not specified.

  • apiproxy_errors.Error -- list call failed.

google.appengine.api.prospective_search.prospective_search_admin.list_topics(max_results, app_id=None, topic_start=None)source

List topics, over-riding app_id.

  • max_results -- maximum number of topics to return.

  • app_id -- if not None, use this app_id.

  • topic_start -- if not None, start listing topics from this one.


List of topics (strings), or an empty list if the caller is not an

administrator and the app_id does not match the app_id of the application.

Send feedback about...

App Engine standard environment for Python