The GetResponse Class

Class GetResponse represents the results of methods invoked to return information about documents and indexes.

GetResponse is defined in the module google.appengine.api.search.

Introduction

A GetResponse object is returned from a call to either index.get_range() or search.get_indexes(). You can iterate over an instance of GetResponse, which will return the members of its results property. The contents of the property are determined by the type of call that created the instance of GetResponse.

For example, the following code shows how GetResponse could be used to determine which documents were successfully deleted. In this case the iteration returns Documents .

response = index.get_range()
for document in response:
 print "document ", document

Constructor

The constructor for class GetResponse is defined as follows:

class GetResponse(results=None)

Construct an instance of class GetResponse.

Argument

results

Initial value of its results property.

Result value

A new instance of class GetResponse.

Exceptions

TypeError

A parameter has an invalid type, or an unknown attribute was passed.

ValueError

A parameter has an invalid value.

Properties

An instance of class GetResponse has the following property:

results

A list of results, whose type depends on the call that returns the object. If returning from a call to get_range(), results is a list of Documents in descending order of their identifiers. If returning from a call to search.get_indexes(), results is a list of Indexes.