QueryOptions.Builder(Google App Engine API for Java)

com.google.appengine.api.search

クラス QueryOptions.Builder

  • java.lang.Object
    • com.google.appengine.api.search.QueryOptions.Builder
  • 含まれているクラス:
    QueryOptions


    public static final class QueryOptions.Builder
    extends java.lang.Object
    QueryOptions オブジェクトを構築するビルダー。
    • メソッドの詳細

      • setLimit

        public QueryOptions.Builder setLimit(int limit)
        Results に返すドキュメント数の制限を設定します。
        パラメータ:
        limit - 返されるドキュメントの数
        戻り値:
        このビルダー
        スロー:
        java.lang.IllegalArgumentException - numDocumentsToReturn が許容範囲内ではない場合
      • setCursor

        public QueryOptions.Builder setCursor(Cursor cursor)
        カーソルを設定します。カーソルは、Results または個別の ScoredDocuments の 1 つから取得されます。次のコードに示します。

         Cursor cursor = Cursor.newBuilder().build();
        
         SearchResults results = index.search(
             Query.newBuilder()
                 .setOptions(QueryOptions.newBuilder()
                     .setLimit(20)
                     .setCursor(cursor)
                     .build())
                 .build("some query"));
        
         // If the Cursor is built without setPerResult(true), then
         // by default a single Cursor is returned with the
         // Results.
         cursor = results.getCursor();
        
         for (ScoredDocument result : results) {
             // If you set Cursor.newBuilder().setPerResult(true)
             // then a cursor is returned with each result.
             result.getCursor();
         
        パラメータ:
        cursor - 前の結果セットから開始点として返されたカーソルを使用して、次の結果セットを取得します。これはより良いパフォーマンスを獲得でき、インデックスの更新によりページ分割の整合性も向上します。
        戻り値:
        このビルダー
      • setOffset

        public QueryOptions.Builder setOffset(int offset)
        最初に返される結果のオフセットを設定します。
        パラメータ:
        offset - 制限された数の結果を返すすべての検索結果へのオフセット
        戻り値:
        このビルダー
        スロー:
        java.lang.IllegalArgumentException - オフセットが負の値または次を超える場合。SearchApiLimits.SEARCH_MAXIMUM_OFFSET
      • setNumberFoundAccuracy

        public QueryOptions.Builder setNumberFoundAccuracy(int numberFoundAccuracy)
        Results.getNumberFound() の正確性に関する要件を設定します。これを設定すると、getNumberFound() は少なくともその数値までは正確になります。たとえば、100 に設定すると、getNumberFound() <= 100 は正確になります。このオプションを使用すると、特に setFieldsToReturn(String...) と併用した場合には、レイテンシやコストが大幅に増えることがあります。
        パラメータ:
        numberFoundAccuracy - 正確性に関する最小要件
        戻り値:
        このビルダー
        スロー:
        java.lang.IllegalArgumentException - 精度が許容範囲内ではない場合
      • setFieldsToReturn

        public QueryOptions.Builder setFieldsToReturn(java.lang.String... fields)
        結果に返すフィールドを 1 つ以上指定します。
        パラメータ:
        fields - 結果に返すフィールドの名前
        戻り値:
        このビルダー
        スロー:
        java.lang.IllegalArgumentException - いずれかのフィールド名が無効な場合
      • setFieldsToSnippet

        public QueryOptions.Builder setFieldsToSnippet(java.lang.String... fieldsToSnippet)
        結果でスニペット化するフィールドを 1 つ以上指定します。スニペットは、ScoredDocument.getExpressions() で同じ名前のフィールドとして返されます。
        パラメータ:
        fieldsToSnippet - 結果でスニペット化するフィールドの名前
        戻り値:
        このビルダー
        スロー:
        java.lang.IllegalArgumentException - いずれかのフィールド名が無効な場合
      • addExpressionToReturn

        public QueryOptions.Builder addExpressionToReturn(FieldExpression.Builder expressionBuilder)
        指定した expressionBuilder から FieldExpression ビルドを追加して、検索結果に返します。スニペットは、ScoredDocument.getExpressions() で同じ名前のフィールドとして返されます。
        パラメータ:
        expressionBuilder - 評価して結果に返す名前付き式のビルダー
        戻り値:
        このビルダー
      • setReturningIdsOnly

        public QueryOptions.Builder setReturningIdsOnly(boolean idsOnly)
        検索によってドキュメントまたはドキュメント ID のみのいずれが返されるかを設定します。この設定には、addExpressionToReturn(FieldExpression) および setFieldsToReturn(String...) メソッドとの互換性がありません。
        パラメータ:
        idsOnly - 検索リクエストによってドキュメントの ID のみが返されるかどうか
        戻り値:
        このビルダー
      • addExpressionToReturn

        public QueryOptions.Builder addExpressionToReturn(FieldExpression expression)
        FieldExpression を追加して検索結果に返します。
        パラメータ:
        expression - 計算して結果に返す名前付き式
        戻り値:
        このビルダー
      • setSortOptions

        public QueryOptions.Builder setSortOptions(SortOptions sortOptions)
        ドキュメントの並べ替えに使用する SortOptions を設定します。
        パラメータ:
        sortOptions - Results でのドキュメントの並べ替え方法を指定します。
        戻り値:
        このビルダー
      • build

        public QueryOptions build()
        最終メッセージを作成します。
        戻り値:
        このビルダーに対して入力されたパラメータから構築された QueryOptions
        スロー:
        java.lang.IllegalArgumentException - 検索リクエストが無効な場合
このページは役立ちましたか?評価をお願いいたします。

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

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