SearchParams クラス - OpenSearch - Alibaba Cloud ドキュメントセンター

SearchParams は Open Search の検索リクエストを構築します。これを使用して、クエリキーワードの設定、フィルターの適用、ランキングとソートの構成、集約の追加、その他の検索動作の制御を行い、アセンブルされたオブジェクトを検索 API に渡します。

コンストラクタ

シグネチャ	説明
`SearchParams(Config config)`	`Config` オブジェクトで初期化します。
`SearchParams()`	パラメーターなしで初期化します。

メソッド

セッター

`setQuery`

SearchParams setQuery(String query)

全文検索のクエリキーワードを設定します。

パラメーター	型	説明
`query`	`String`	クエリキーワード。

`setFilter`

SearchParams setFilter(String filter)

検索結果を絞り込むためのフィルター条件を設定します。

パラメーター	型	説明
`filter`	`String`	フィルター条件。

`setSuggest`

SearchParams setSuggest(Suggest suggest)

クエリパラメーターとして Suggest オブジェクトを設定します。

パラメーター	型	説明
`suggest`	`Suggest`	Suggest オブジェクト。

`setConfig`

SearchParams setConfig(Config config)

クエリパラメーターとして Config オブジェクトを設定します。

パラメーター	型	説明
`config`	`Config`	Config オブジェクト。

`setQueryProcessorNames`

SearchParams setQueryProcessorNames(List<String> queryProcessorNames)

クエリアナライザの完全なリストを設定します。

パラメーター	型	説明
`queryProcessorNames`	`List<String>`	クエリアナライザのリスト。

リストを置き換えるのではなく、クエリアナライザを一度に1つずつ追加するには、addToQueryProcessorNames を使用します。

`setAggregates`

SearchParams setAggregates(Set<Aggregate> aggreates)

Aggregate オブジェクトの完全なコレクションを設定します。

パラメーター	型	説明
`aggreates`	`Set<Aggregate>`	Aggregate オブジェクトのセット。

コレクションを置き換えるのではなく、Aggregate オブジェクトを一度に1つずつ追加するには、addToAggregates を使用します。

`setDistincts`

SearchParams setDistincts(Set<Distinct> distincts)

Distinct オブジェクトの完全なコレクションを設定します。

パラメーター	型	説明
`distincts`	`Set<Distinct>`	Distinct オブジェクトのセット。

コレクションを置き換えるのではなく、Distinct オブジェクトを一度に1つずつ追加するには、addToDistincts を使用します。

`setRank`

SearchParams setRank(Rank rank)

クエリパラメーターとして Rank オブジェクトを設定します。

パラメーター	型	説明
`rank`	`Rank`	Rank オブジェクト。

`setSort`

SearchParams setSort(Sort sort)

クエリパラメーターとして Sort オブジェクトを設定します。

パラメーター	型	説明
`sort`	`Sort`	Sort オブジェクト。

`setSummaries`

SearchParams setSummaries(Set<Summary> summaries)

Summary オブジェクトのコレクション全体を設定します。

パラメーター	型	説明
`summaries`	`Set<Summary>`	Summary オブジェクトのセット。

コレクションを置き換えるのではなく、Summary オブジェクトを一度に1つずつ追加するには、addToSummaries を使用します。

`setDeepPaging`

SearchParams setDeepPaging(DeepPaging deepPaging)

クエリパラメーターとして DeepPaging オブジェクトを設定します。

パラメーター	型	説明
`deepPaging`	`DeepPaging`	DeepPaging オブジェクト。

アダー

`addToQueryProcessorNames`

void addToQueryProcessorNames(String qpName)

単一のクエリアナライザを追加します。

パラメーター	型	説明
`qpName`	`String`	追加するクエリアナライザ。

`addToAggregates`

void addToAggregates(Aggregate aggregate)

既存のコレクションに単一の Aggregate オブジェクトを追加します。

パラメーター	型	説明
`aggregate`	`Aggregate`	追加する Aggregate オブジェクト。

`addToDistincts`

void addToDistincts(Distinct distinct)

既存のコレクションに単一の Distinct オブジェクトを追加します。

パラメーター	型	説明
`distinct`	`Distinct`	追加する Distinct オブジェクト。

`addToSummaries`

void addToSummaries(Summary summary)

既存のコレクションに単一の Summary オブジェクトを追加します。

パラメーター	型	説明
`summary`	`Summary`	追加する Summary オブジェクト。

ゲッター

`getQuery`

String getQuery()

クエリキーワードを返します。

`getSuggest`

Suggest getSuggest()

クエリパラメーターとして設定されている Suggest オブジェクトを返します。

`getConfig`

Config getConfig()

クエリパラメーターとして設定されている Config オブジェクトを返します。

`getQueryProcessorNames`

List<String> getQueryProcessorNames()

クエリアナライザのリストを返します。

`getAggregates`

Set<Aggregate> getAggregates()

Aggregate オブジェクトのセットを返します。

`getDistincts`

Set<Distinct> getDistincts()

Distinct オブジェクトのセットを返します。

`getRank`

Rank getRank()

クエリパラメーターとして設定されている Rank オブジェクトを返します。

`getSort`

Sort getSort()

クエリパラメーターとして設定されている Sort オブジェクトを返します。

`getSummaries`

Set<Summary> getSummaries()

Summary オブジェクトのセットを返します。

`getDeepPaging`

DeepPaging getDeepPaging()

クエリパラメーターとして設定されている DeepPaging オブジェクトを返します。