GetResponse クラス

GetResponse クラスは、ドキュメントとインデックスに関する情報を返すために呼び出されたメソッドの結果を表します。

GetResponse は、google.appengine.api.search モジュールで定義されます。

はじめに

GetResponse オブジェクトは、index.get_range() または search.get_indexes() の呼び出しから返されます。GetResponse のインスタンスを反復処理すると、その results プロパティのメンバーが返されます。プロパティの内容は、GetResponse のインスタンスを作成した呼び出しの種類によって決まります。

たとえば、次のコードは GetResponse を使用して正常に削除されたドキュメントを特定する方法を示しています。この場合、反復処理によって複数のドキュメントが返されます。

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

コンストラクタ

GetResponse クラスのコンストラクタは、次のように定義されます。

class GetResponse(results=None)

クラス GetResponse のインスタンスを作成します。

引数

results

results プロパティの初期値。

結果値

GetResponse クラスの新しいインスタンス。

例外

TypeError

パラメータの型が無効であるか、不明な属性が渡されました。

ValueError

パラメータの値が無効です。

プロパティ

GetResponse クラスのインスタンスには次のプロパティがあります。

results

オブジェクトを返す呼び出しに応じて型が異なる結果のリスト。get_range() が呼び出された場合、識別子の降順で並び替えられたドキュメントのリストが results として返されます。search.get_indexes() が呼び出された場合、インデックスのリストが results として返されます。