ClassGetResponse representsthe results of methods invoked to return information about documents and indexes.

GetResponse is defined in the modulegoogle.appengine.api.search.

Introduction

AGetResponse object is returned from a call to eitherindex.get_range()orsearch.get_indexes().You can iterate over an instance ofGetResponse, which will return the members of itsresults property. The contents of the propertyare determined by the type of call that created the instance ofGetResponse.

For example, the following code shows howGetResponse could be used todetermine which documents were successfully deleted. In this casethe iteration returnsDocuments.

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

Constructor

The constructor for classGetResponse is defined as follows:

class GetResponse(results=None)

Construct an instance of classGetResponse.

Argument

results

Initial value of itsresults property.

Result value

A new instance of classGetResponse.

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 classGetResponse has the following property:

results

A list of results, whose type depends on the call that returns the object. If returning from a call toget_range(),results is a list ofDocuments in descending order of their identifiers. If returning from a call tosearch.get_indexes(),results is a list ofIndexes.