ProspectiveSearchService(Google App Engine API for Java)

com.google.appengine.api.prospectivesearch

インターフェース ProspectiveSearchService


  • サポート終了。 
    この API のサポートは終了しました。

    @Deprecated
    public interface ProspectiveSearchService
    Prospective Search App Engine API は、App Engine サービスとして、リアルタイムかつスケーラブルな Google Prospective Search Infrastructure を公開しています。ProspectiveSearch API によって、アプリで一連のクエリを単純なクエリの形式で登録し、提示されるドキュメントと照合できます。提示されるすべてのドキュメントについて、このマッチャーは一致するすべてのクエリの ID を返します。多数一致する可能性のあるクエリをこのアプリで処理できるようにするため、一致した ID は TaskQueue でタスクとしてキューに入れられます。一致通知のターゲットは、メンバー DEFAULT_RESULT_RELATIVE_URL で定義されます。
    関連情報:
    デベロッパー ガイドのクエリ言語の概要、デベロッパー ガイドの一致の処理
    • フィールドの概要

      フィールド 
      修飾子と型 フィールドと説明
      static int DEFAULT_LEASE_DURATION_SEC
      サポート終了。 
      デフォルトのリースの期限値ゼロは、有効期限がないことを意味します。
      static int DEFAULT_LIST_SUBSCRIPTIONS_MAX_RESULTS
      サポート終了。 
      バックエンド サービスのデフォルトのバッチサイズに設定します。
      static int DEFAULT_LIST_TOPICS_MAX_RESULTS
      サポート終了。 
      バックエンド サービスのデフォルトのバッチサイズに設定します。
      static int DEFAULT_RESULT_BATCH_SIZE
      サポート終了。 
      TaskQueue タスクでの迅速な処理を実現するために、小サイズの 100 に設定します。
      static java.lang.String DEFAULT_RESULT_RELATIVE_URL
      サポート終了。 
      一致が POSTed となるデフォルトの URI パス。
      static java.lang.String DEFAULT_RESULT_TASK_QUEUE_NAME
      サポート終了。 
      デフォルトのタスクキューを使用します。
    • メソッドの概要

      すべてのメソッド インスタンス メソッド 抽象メソッド サポート終了メソッド 
      修飾子と型 メソッドと説明
      Entity getDocument(HttpServletRequest matchCallbackPost)
      サポート終了。 
      match(Entity, String, String, String, String, int, boolean) の結果の POST リクエストからのドキュメントをデコードします。
      Subscription getSubscription(java.lang.String topic, java.lang.String subId)
      サポート終了。 
      指定したトピックおよび ID を持つ Subscription を取得します。
      java.util.List<Subscription> listSubscriptions(java.lang.String topic)
      サポート終了。 
      次と同等です。
      java.util.List<Subscription> listSubscriptions(java.lang.String topic, java.lang.String subIdStart, int maxResults, long expiresBefore)
      サポート終了。 
      listSubscriptions 呼び出しは、現在アクティブなサブスクリプションをリスト表示します。
      java.util.List<java.lang.String> listTopics(java.lang.String topicStart, long maxResults)
      サポート終了。 
      トピックを辞書順にリスト表示します。
      void match(Entity document, java.lang.String topic)
      サポート終了。 
      次と同等です。
      void match(Entity document, java.lang.String topic, java.lang.String resultKey)
      サポート終了。 
      次と同等です。
      void match(Entity document, java.lang.String topic, java.lang.String resultKey, java.lang.String resultRelativeUrl, java.lang.String resultTaskQueueName, int resultBatchSize, boolean resultReturnDocument)
      サポート終了。 
      match 呼び出しを使用して、登録されている同じトピックのすべてのサブスクリプションに一致するドキュメントを提示します。
      void subscribe(java.lang.String topic, java.lang.String subId, long leaseDurationSeconds, java.lang.String query, java.util.Map<java.lang.String,FieldType> schema)
      サポート終了。 
      subscribe 呼び出しは、サブスクリプション ID およびクエリで構成されるサブスクリプションを登録するために使用されます。
      void unsubscribe(java.lang.String topic, java.lang.String subId)
      サポート終了。 
      サブスクリプションは、unsubscribe 呼び出しを使用してシステムから削除します。
    • フィールドの詳細

      • DEFAULT_LEASE_DURATION_SEC

        static final int DEFAULT_LEASE_DURATION_SEC
        サポート終了。 
        デフォルトのリースの期限値ゼロは、有効期限がないことを意味します。
        関連情報:
        定数フィールド値
      • DEFAULT_LIST_SUBSCRIPTIONS_MAX_RESULTS

        static final int DEFAULT_LIST_SUBSCRIPTIONS_MAX_RESULTS
        サポート終了。 
        バックエンド サービスのデフォルトのバッチサイズに設定します。
        関連情報:
        定数フィールド値
      • DEFAULT_LIST_TOPICS_MAX_RESULTS

        static final int DEFAULT_LIST_TOPICS_MAX_RESULTS
        サポート終了。 
        バックエンド サービスのデフォルトのバッチサイズに設定します。
        関連情報:
        定数フィールド値
      • DEFAULT_RESULT_BATCH_SIZE

        static final int DEFAULT_RESULT_BATCH_SIZE
        サポート終了。 
        TaskQueue タスクでの迅速な処理を実現するために、小サイズの 100 に設定します。
        関連情報:
        定数フィールド値
      • DEFAULT_RESULT_RELATIVE_URL

        static final java.lang.String DEFAULT_RESULT_RELATIVE_URL
        サポート終了。 
        一致が POSTed となるデフォルトの URI パス。アプリケーションでこのロケーションにハンドラをインストールする必要があります。_ah 接頭辞は、このパスにアクセスできるのはアプリケーションのみにし、公開 HTTP 接続経由ではアクセスできないようにします。
        関連情報:
        定数フィールド値
      • DEFAULT_RESULT_TASK_QUEUE_NAME

        static final java.lang.String DEFAULT_RESULT_TASK_QUEUE_NAME
        サポート終了。 
        デフォルトのタスクキューを使用します。次と同等です。
         com.google.appengine.api.taskqueue.QueueFactory.getDefaultQueue().getQueueName()
         
    • メソッドの詳細

      • subscribe

        void subscribe(java.lang.String topic,
                       java.lang.String subId,
                       long leaseDurationSeconds,
                       java.lang.String query,
                       java.util.Map<java.lang.String,FieldType> schema)
        サポート終了。 
        subscribe 呼び出しは、サブスクリプション ID およびクエリで構成されるサブスクリプションを登録するために使用されます。subscribe が成功した後、サブスクリプションが登録されるまで、数秒の遅延が想定されます。
        パラメータ:
        topic - このサブスクリプションを追加するサブスクリプション グループ。トピックが同じ match(com.google.appengine.api.datastore.Entity, java.lang.String) 呼び出しのみが、このサブスクリプションと一致します。
        subId - このサブスクリプションの一意の文字列。subscribe によって、同じ subId を持つサブスクリプションが上書きされます。
        query - 単純なクエリの形式のクエリ。
        leaseDurationSeconds - サブスクリプションが自動的に削除されるまでの時間。値 0 の場合は有効期限がありません。
        schema - フィールド名とその対応するタイプのマッピング。
        スロー:
        QuerySyntaxException - クエリが無効であるか、スキーマと一致しない場合。
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。理由については、メッセージの詳細を参照してください。
      • unsubscribe

        void unsubscribe(java.lang.String topic,
                         java.lang.String subId)
        サポート終了。 
        サブスクリプションは、unsubscribe 呼び出しを使用してシステムから削除します。unsubscribe 呼び出しが正常に終了すると、サブスクリプションが結果的に削除されます。unsubscribe が成功した後、サブスクリプションが削除されるまで、数秒の遅延が想定されます。指定したトピックの最後のサブスクリプションが削除されると、トピックも存在しなくなります。
        パラメータ:
        topic - サブスクリプションのサブスクリプション グループ。
        subId - 削除するサブスクリプションの ID。次で指定されます。subscribe(java.lang.String, java.lang.String, long, java.lang.String, java.util.Map<java.lang.String, com.google.appengine.api.prospectivesearch.FieldType>)
        スロー:
        java.lang.IllegalArgumentException - 指定したトピックが存在しないか、そのトピックに指定した subId のサブスクリプションがない場合。
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。理由については、メッセージの詳細を参照してください。
      • match

        void match(Entity document,
                   java.lang.String topic)
        サポート終了。 
        次と同等です。
           match(entity, topic, "");
         
        関連情報:
        match(Entity, String, String)
      • match

        void match(Entity document,
                   java.lang.String topic,
                   java.lang.String resultKey)
        サポート終了。 
        次と同等です。
           match(entity, topic, resultKey,
                 DEFAULT_RESULT_RELATIVE_URL,
                 DEFAULT_RESULT_TASK_QUEUE_NAME,
                 DEFAULT_RESULT_BATCH_SIZE,
                 true);
         
        関連情報:
        match(Entity, String, String, String, String, int, boolean)
      • match

        void match(Entity document,
                   java.lang.String topic,
                   java.lang.String resultKey,
                   java.lang.String resultRelativeUrl,
                   java.lang.String resultTaskQueueName,
                   int resultBatchSize,
                   boolean resultReturnDocument)
        サポート終了。 
        match 呼び出しを使用して、登録されている同じトピックのすべてのサブスクリプションに一致するドキュメントを提示します。match の結果メッセージは、TaskQueue POST を介して指定した resultRelativeURL に非同期に配信されます。
        パラメータ:
        document - 登録されたサブスクリプションに一致するドキュメント
        topic - 一致するサブスクリプション グループ
        resultKey - 結果メッセージをこの呼び出しに関連付けるために使用できる結果メッセージとともに返されるユーザー定義のキー
        resultRelativeUrl - 結果メッセージが配信される相対 URL
        resultTaskQueueName - 結果メッセージの配信に使用する TaskQueue の名前
        resultBatchSize - 結果メッセージごとのサブスクリプション ID の最大数
        スロー:
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。理由については、メッセージの詳細を参照してください。
        関連情報:
        デベロッパー ガイドの一致の処理
      • listSubscriptions

        java.util.List<Subscription> listSubscriptions(java.lang.String topic,
                                                       java.lang.String subIdStart,
                                                       int maxResults,
                                                       long expiresBefore)
        サポート終了。 
        listSubscriptions 呼び出しは、現在アクティブなサブスクリプションをリスト表示します。
        パラメータ:
        topic - リスト表示するサブスクリプション グループ。
        subIdStart - 辞書順が指定した値以上のサブスクリプションが返されます。注: 空の文字列の順序がその他すべての文字列よりも先になります。
        maxResults - 返されるサブスクリプションの最大数を設定します。
        expiresBefore - 返されるサブスクリプションを、指定したエポックからの時間(秒)より前に有効期限切れになるものに制限します。0 の場合は有効期限がありません。
        戻り値:
        サブスクリプションのリスト
        スロー:
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。理由については、メッセージの詳細を参照してください。
      • getSubscription

        Subscription getSubscription(java.lang.String topic,
                                     java.lang.String subId)
        サポート終了。 
        指定したトピックおよび ID を持つ Subscription を取得します。
        パラメータ:
        topic - サブスクリプションが属するサブスクリプション グループ
        subId - サブスクリプションの ID
        戻り値:
        サブスクリプション
        スロー:
        java.lang.IllegalArgumentException - そのようなサブスクリプションが存在しない場合。
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。その理由については、メッセージの詳細を参照してください。
      • listTopics

        java.util.List<java.lang.String> listTopics(java.lang.String topicStart,
                                                    long maxResults)
        サポート終了。 
        トピックを辞書順にリスト表示します。
        パラメータ:
        topicStart - リスト表示の先頭のトピック。最初から開始する場合はからの文字列。
        maxResults - 返されるトピックの最大数。適切なデフォルトは 1,000 です。
        戻り値:
        トピック名のリスト
        スロー:
        ApiProxy.ApplicationException - backend 呼び出しが失敗した場合。理由については、メッセージの詳細を参照してください。
      • getDocument

        Entity getDocument(HttpServletRequest matchCallbackPost)
        サポート終了。 
        match(Entity, String, String, String, String, int, boolean) の結果の POST リクエストからのドキュメントをデコードします。
        パラメータ:
        matchCallbackPost - 受信した POST リクエスト
        戻り値:
        match 呼び出しの結果、サブスクリプションに一致したエンティティ。デコードできない場合は null。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境