The Search API provides a number of response classes defined within the google.appengine.api.search module. These response classes represent the result of methods invoked to return information about documents, indexes, and searches. The classes are:

1. class GetResponse

GetResponse

Class GetResponse represents the result of executing index.get_range() request. It is an iterable of the Document class.

For example, the following code shows how a response could be used to determine which documents were successfully deleted:

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

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

Class GetResponse is defined as follows:

class GetResponse(results=None)

Construct an instance of class GetResponse.

Argument

results

List of results returned from a call to get_range(), in descending order of their order identifiers.

Result value

A new instance of class Document.

Exceptions

TypeError

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

ValueError

A parameter has an invalid value.

Property

An instance of class GetResponse has the following property:

results

List of results returned from a call to get_range(), in descending order of their order identifiers.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.