SearchParams (Aliyun OPENSEARCH SDK for Java 6.0.0 API)

java.lang.Object
- com.aliyun.opensearch.sdk.generated.search.SearchParams

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<SearchParams>, org.apache.thrift.TBase<SearchParams,SearchParams._Fields>

@Generated(value="Autogenerated by Thrift Compiler (0.9.3)",
           date="2020-09-19")
public class SearchParams
extends java.lang.Object
implements org.apache.thrift.TBase<SearchParams,SearchParams._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<SearchParams>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchParams._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type	Field and Description
`Abtest`	`abtest` Abtest
`java.util.Set<Aggregate>`	`aggregates` 添加统计信息(aggregate)相关参数
`Config`	`config` config for search.
`java.util.Map<java.lang.String,java.lang.String>`	`customClause` 自定义查询子句
`java.util.Map<java.lang.String,java.lang.String>`	`customParam`
`DeepPaging`	`deepPaging`
`java.util.Map<java.lang.String,java.lang.String>`	`disableFunctions` 关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“\|”分隔，可以为index_name1\|index_name2...
`java.util.Set<Distinct>`	`distincts` 聚合打散条件
`java.lang.String`	`filter` 过滤规则(filter)
`FinalDistinct`	`finalDistinct` 精排聚合打散条件
`static java.util.Map<SearchParams._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`java.lang.String`	`query` 设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
`java.util.List<java.lang.String>`	`queryProcessorNames` 设置查询分析规则(qp)
`Rank`	`rank`
`java.lang.String`	`rawQuery` 终端用户输入的query
`Sort`	`sort` 排序字段及排序方式(sort)
`Suggest`	`suggest` 下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
`java.util.Set<Summary>`	`summaries` 动态摘要(summary)信息
`java.lang.String`	`userId` 终端用户的id，用来统计uv信息

Constructor Summary

Constructors
Constructor and Description

SearchParams()

SearchParams(Config config)

SearchParams(SearchParams other)
Performs a deep copy on other.

Constructors
Constructor and Description
`SearchParams()`
`SearchParams(Config config)`
`SearchParams(SearchParams other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToAggregates(Aggregate elem)`
`void`	`addToDistincts(Distinct elem)`
`void`	`addToQueryProcessorNames(java.lang.String elem)`
`void`	`addToSummaries(Summary elem)`
`void`	`clear()`
`int`	`compareTo(SearchParams other)`
`SearchParams`	`deepCopy()`
`boolean`	`equals(java.lang.Object that)`
`boolean`	`equals(SearchParams that)`
`SearchParams._Fields`	`fieldForId(int fieldId)`
`Abtest`	`getAbtest()` Abtest
`java.util.Set<Aggregate>`	`getAggregates()` 添加统计信息(aggregate)相关参数
`java.util.Iterator<Aggregate>`	`getAggregatesIterator()`
`int`	`getAggregatesSize()`
`Config`	`getConfig()` config for search.
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomClause()` 自定义查询子句
`int`	`getCustomClauseSize()`
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomParam()`
`int`	`getCustomParamSize()`
`DeepPaging`	`getDeepPaging()`
`java.util.Map<java.lang.String,java.lang.String>`	`getDisableFunctions()` 关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“\|”分隔，可以为index_name1\|index_name2...
`int`	`getDisableFunctionsSize()`
`java.util.Set<Distinct>`	`getDistincts()` 聚合打散条件
`java.util.Iterator<Distinct>`	`getDistinctsIterator()`
`int`	`getDistinctsSize()`
`java.lang.Object`	`getFieldValue(SearchParams._Fields field)`
`java.lang.String`	`getFilter()` 过滤规则(filter)
`FinalDistinct`	`getFinalDistinct()` 精排聚合打散条件
`java.lang.String`	`getQuery()` 设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
`java.util.List<java.lang.String>`	`getQueryProcessorNames()` 设置查询分析规则(qp)
`java.util.Iterator<java.lang.String>`	`getQueryProcessorNamesIterator()`
`int`	`getQueryProcessorNamesSize()`
`Rank`	`getRank()`
`java.lang.String`	`getRawQuery()` 终端用户输入的query
`Sort`	`getSort()` 排序字段及排序方式(sort)
`Suggest`	`getSuggest()` 下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
`java.util.Set<Summary>`	`getSummaries()` 动态摘要(summary)信息
`java.util.Iterator<Summary>`	`getSummariesIterator()`
`int`	`getSummariesSize()`
`java.lang.String`	`getUserId()` 终端用户的id，用来统计uv信息
`int`	`hashCode()`
`boolean`	`isSet(SearchParams._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAbtest()` Returns true if field abtest is set (has been assigned a value) and false otherwise
`boolean`	`isSetAggregates()` Returns true if field aggregates is set (has been assigned a value) and false otherwise
`boolean`	`isSetConfig()` Returns true if field config is set (has been assigned a value) and false otherwise
`boolean`	`isSetCustomClause()` Returns true if field customClause is set (has been assigned a value) and false otherwise
`boolean`	`isSetCustomParam()` Returns true if field customParam is set (has been assigned a value) and false otherwise
`boolean`	`isSetDeepPaging()` Returns true if field deepPaging is set (has been assigned a value) and false otherwise
`boolean`	`isSetDisableFunctions()` Returns true if field disableFunctions is set (has been assigned a value) and false otherwise
`boolean`	`isSetDistincts()` Returns true if field distincts is set (has been assigned a value) and false otherwise
`boolean`	`isSetFilter()` Returns true if field filter is set (has been assigned a value) and false otherwise
`boolean`	`isSetFinalDistinct()` Returns true if field finalDistinct is set (has been assigned a value) and false otherwise
`boolean`	`isSetQuery()` Returns true if field query is set (has been assigned a value) and false otherwise
`boolean`	`isSetQueryProcessorNames()` Returns true if field queryProcessorNames is set (has been assigned a value) and false otherwise
`boolean`	`isSetRank()` Returns true if field rank is set (has been assigned a value) and false otherwise
`boolean`	`isSetRawQuery()` Returns true if field rawQuery is set (has been assigned a value) and false otherwise
`boolean`	`isSetSort()` Returns true if field sort is set (has been assigned a value) and false otherwise
`boolean`	`isSetSuggest()` Returns true if field suggest is set (has been assigned a value) and false otherwise
`boolean`	`isSetSummaries()` Returns true if field summaries is set (has been assigned a value) and false otherwise
`boolean`	`isSetUserId()` Returns true if field userId is set (has been assigned a value) and false otherwise
`void`	`putToCustomClause(java.lang.String key, java.lang.String val)`
`void`	`putToCustomParam(java.lang.String key, java.lang.String val)`
`void`	`putToDisableFunctions(java.lang.String key, java.lang.String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`SearchParams`	`setAbtest(Abtest abtest)` Abtest
`void`	`setAbtestIsSet(boolean value)`
`SearchParams`	`setAggregates(java.util.Set<Aggregate> aggregates)` 添加统计信息(aggregate)相关参数
`void`	`setAggregatesIsSet(boolean value)`
`SearchParams`	`setConfig(Config config)` config for search.
`void`	`setConfigIsSet(boolean value)`
`SearchParams`	`setCustomClause(java.util.Map<java.lang.String,java.lang.String> customClause)` 自定义查询子句
`void`	`setCustomClauseIsSet(boolean value)`
`SearchParams`	`setCustomParam(java.util.Map<java.lang.String,java.lang.String> customParam)`
`void`	`setCustomParamIsSet(boolean value)`
`SearchParams`	`setDeepPaging(DeepPaging deepPaging)`
`void`	`setDeepPagingIsSet(boolean value)`
`SearchParams`	`setDisableFunctions(java.util.Map<java.lang.String,java.lang.String> disableFunctions)` 关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“\|”分隔，可以为index_name1\|index_name2...
`void`	`setDisableFunctionsIsSet(boolean value)`
`SearchParams`	`setDistincts(java.util.Set<Distinct> distincts)` 聚合打散条件
`void`	`setDistinctsIsSet(boolean value)`
`void`	`setFieldValue(SearchParams._Fields field, java.lang.Object value)`
`SearchParams`	`setFilter(java.lang.String filter)` 过滤规则(filter)
`void`	`setFilterIsSet(boolean value)`
`SearchParams`	`setFinalDistinct(FinalDistinct finalDistinct)` 精排聚合打散条件
`void`	`setFinalDistinctIsSet(boolean value)`
`SearchParams`	`setQuery(java.lang.String query)` 设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
`void`	`setQueryIsSet(boolean value)`
`SearchParams`	`setQueryProcessorNames(java.util.List<java.lang.String> queryProcessorNames)` 设置查询分析规则(qp)
`void`	`setQueryProcessorNamesIsSet(boolean value)`
`SearchParams`	`setRank(Rank rank)`
`void`	`setRankIsSet(boolean value)`
`SearchParams`	`setRawQuery(java.lang.String rawQuery)` 终端用户输入的query
`void`	`setRawQueryIsSet(boolean value)`
`SearchParams`	`setSort(Sort sort)` 排序字段及排序方式(sort)
`void`	`setSortIsSet(boolean value)`
`SearchParams`	`setSuggest(Suggest suggest)` 下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
`void`	`setSuggestIsSet(boolean value)`
`SearchParams`	`setSummaries(java.util.Set<Summary> summaries)` 动态摘要(summary)信息
`void`	`setSummariesIsSet(boolean value)`
`SearchParams`	`setUserId(java.lang.String userId)` 终端用户的id，用来统计uv信息
`void`	`setUserIdIsSet(boolean value)`
`java.lang.String`	`toString()`
`void`	`unsetAbtest()`
`void`	`unsetAggregates()`
`void`	`unsetConfig()`
`void`	`unsetCustomClause()`
`void`	`unsetCustomParam()`
`void`	`unsetDeepPaging()`
`void`	`unsetDisableFunctions()`
`void`	`unsetDistincts()`
`void`	`unsetFilter()`
`void`	`unsetFinalDistinct()`
`void`	`unsetQuery()`
`void`	`unsetQueryProcessorNames()`
`void`	`unsetRank()`
`void`	`unsetRawQuery()`
`void`	`unsetSort()`
`void`	`unsetSuggest()`
`void`	`unsetSummaries()`
`void`	`unsetUserId()`
`void`	`validate()`
`void`	`write(org.apache.thrift.protocol.TProtocol oprot)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - config
```
public Config config
```
    config for search.
  - query
```
public java.lang.String query
```
    设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
    
    See Also:
    
    Query Clause
  - filter
```
public java.lang.String filter
```
    过滤规则(filter)
  - sort
```
public Sort sort
```
    排序字段及排序方式(sort)
  - rank
```
public Rank rank
```
  - aggregates
```
public java.util.Set<Aggregate> aggregates
```
    添加统计信息(aggregate)相关参数
  - distincts
```
public java.util.Set<Distinct> distincts
```
    聚合打散条件
  - summaries
```
public java.util.Set<Summary> summaries
```
    动态摘要(summary)信息
  - queryProcessorNames
```
public java.util.List<java.lang.String> queryProcessorNames
```
    设置查询分析规则(qp)
  - deepPaging
```
public DeepPaging deepPaging
```
  - disableFunctions
```
public java.util.Map<java.lang.String,java.lang.String> disableFunctions
```
    关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2... 3、如果要关闭多个function可以用“,”分隔，例如：disableValue="qp:function_name1:index_name1,qp:function_name2:index_name1" qp有如下模块： 1、spell_check: 检查用户查询串中的拼写错误，并给出纠错建议。 2、term_weighting: 分析查询中每个词的重要程度，并将其量化成权重，权重较低的词可能不会参与召回。 3、stop_word: 根据系统内置的停用词典过滤查询中无意义的词 4、synonym: 根据系统提供的通用同义词库和语义模型，对查询串进行同义词扩展，以便扩大召回。 example: "qp" 标示关闭整个qp "qp:spell_check" 标示关闭qp的拼音纠错功能。 "qp:stop_word:index_name1|index_name2" 标示关闭qp中index_name1和index_name2上的停用词功能。 key 需要禁用的函数名称 value 待禁用函数的详细说明
  - customParam
```
public java.util.Map<java.lang.String,java.lang.String> customParam
```
  - suggest
```
public Suggest suggest
```
    下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
  - abtest
```
public Abtest abtest
```
    Abtest
  - userId
```
public java.lang.String userId
```
    终端用户的id，用来统计uv信息
  - rawQuery
```
public java.lang.String rawQuery
```
    终端用户输入的query
  - finalDistinct
```
public FinalDistinct finalDistinct
```
    精排聚合打散条件
  - customClause
```
public java.util.Map<java.lang.String,java.lang.String> customClause
```
    自定义查询子句
  - metaDataMap
```
public static final java.util.Map<SearchParams._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - SearchParams
```
public SearchParams()
```
  - SearchParams
```
public SearchParams(Config config)
```
  - SearchParams
```
public SearchParams(SearchParams other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public SearchParams deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - getConfig
```
public Config getConfig()
```
    config for search.
  - setConfig
```
public SearchParams setConfig(Config config)
```
    config for search.
  - unsetConfig
```
public void unsetConfig()
```
  - isSetConfig
```
public boolean isSetConfig()
```
    Returns true if field config is set (has been assigned a value) and false otherwise
  - setConfigIsSet
```
public void setConfigIsSet(boolean value)
```
  - getQuery
```
public java.lang.String getQuery()
```
    设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
    
    See Also:
    
    Query Clause
  - setQuery
```
public SearchParams setQuery(java.lang.String query)
```
    设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
    
    See Also:
    
    Query Clause
  - unsetQuery
```
public void unsetQuery()
```
  - isSetQuery
```
public boolean isSetQuery()
```
    Returns true if field query is set (has been assigned a value) and false otherwise
  - setQueryIsSet
```
public void setQueryIsSet(boolean value)
```
  - getFilter
```
public java.lang.String getFilter()
```
    过滤规则(filter)
  - setFilter
```
public SearchParams setFilter(java.lang.String filter)
```
    过滤规则(filter)
  - unsetFilter
```
public void unsetFilter()
```
  - isSetFilter
```
public boolean isSetFilter()
```
    Returns true if field filter is set (has been assigned a value) and false otherwise
  - setFilterIsSet
```
public void setFilterIsSet(boolean value)
```
  - getSort
```
public Sort getSort()
```
    排序字段及排序方式(sort)
  - setSort
```
public SearchParams setSort(Sort sort)
```
    排序字段及排序方式(sort)
  - unsetSort
```
public void unsetSort()
```
  - isSetSort
```
public boolean isSetSort()
```
    Returns true if field sort is set (has been assigned a value) and false otherwise
  - setSortIsSet
```
public void setSortIsSet(boolean value)
```
  - getRank
```
public Rank getRank()
```
  - setRank
```
public SearchParams setRank(Rank rank)
```
  - unsetRank
```
public void unsetRank()
```
  - isSetRank
```
public boolean isSetRank()
```
    Returns true if field rank is set (has been assigned a value) and false otherwise
  - setRankIsSet
```
public void setRankIsSet(boolean value)
```
  - getAggregatesSize
```
public int getAggregatesSize()
```
  - getAggregatesIterator
```
public java.util.Iterator<Aggregate> getAggregatesIterator()
```
  - addToAggregates
```
public void addToAggregates(Aggregate elem)
```
  - getAggregates
```
public java.util.Set<Aggregate> getAggregates()
```
    添加统计信息(aggregate)相关参数
  - setAggregates
```
public SearchParams setAggregates(java.util.Set<Aggregate> aggregates)
```
    添加统计信息(aggregate)相关参数
  - unsetAggregates
```
public void unsetAggregates()
```
  - isSetAggregates
```
public boolean isSetAggregates()
```
    Returns true if field aggregates is set (has been assigned a value) and false otherwise
  - setAggregatesIsSet
```
public void setAggregatesIsSet(boolean value)
```
  - getDistinctsSize
```
public int getDistinctsSize()
```
  - getDistinctsIterator
```
public java.util.Iterator<Distinct> getDistinctsIterator()
```
  - addToDistincts
```
public void addToDistincts(Distinct elem)
```
  - getDistincts
```
public java.util.Set<Distinct> getDistincts()
```
    聚合打散条件
  - setDistincts
```
public SearchParams setDistincts(java.util.Set<Distinct> distincts)
```
    聚合打散条件
  - unsetDistincts
```
public void unsetDistincts()
```
  - isSetDistincts
```
public boolean isSetDistincts()
```
    Returns true if field distincts is set (has been assigned a value) and false otherwise
  - setDistinctsIsSet
```
public void setDistinctsIsSet(boolean value)
```
  - getSummariesSize
```
public int getSummariesSize()
```
  - getSummariesIterator
```
public java.util.Iterator<Summary> getSummariesIterator()
```
  - addToSummaries
```
public void addToSummaries(Summary elem)
```
  - getSummaries
```
public java.util.Set<Summary> getSummaries()
```
    动态摘要(summary)信息
  - setSummaries
```
public SearchParams setSummaries(java.util.Set<Summary> summaries)
```
    动态摘要(summary)信息
  - unsetSummaries
```
public void unsetSummaries()
```
  - isSetSummaries
```
public boolean isSetSummaries()
```
    Returns true if field summaries is set (has been assigned a value) and false otherwise
  - setSummariesIsSet
```
public void setSummariesIsSet(boolean value)
```
  - getQueryProcessorNamesSize
```
public int getQueryProcessorNamesSize()
```
  - getQueryProcessorNamesIterator
```
public java.util.Iterator<java.lang.String> getQueryProcessorNamesIterator()
```
  - addToQueryProcessorNames
```
public void addToQueryProcessorNames(java.lang.String elem)
```
  - getQueryProcessorNames
```
public java.util.List<java.lang.String> getQueryProcessorNames()
```
    设置查询分析规则(qp)
  - setQueryProcessorNames
```
public SearchParams setQueryProcessorNames(java.util.List<java.lang.String> queryProcessorNames)
```
    设置查询分析规则(qp)
  - unsetQueryProcessorNames
```
public void unsetQueryProcessorNames()
```
  - isSetQueryProcessorNames
```
public boolean isSetQueryProcessorNames()
```
    Returns true if field queryProcessorNames is set (has been assigned a value) and false otherwise
  - setQueryProcessorNamesIsSet
```
public void setQueryProcessorNamesIsSet(boolean value)
```
  - getDeepPaging
```
public DeepPaging getDeepPaging()
```
  - setDeepPaging
```
public SearchParams setDeepPaging(DeepPaging deepPaging)
```
  - unsetDeepPaging
```
public void unsetDeepPaging()
```
  - isSetDeepPaging
```
public boolean isSetDeepPaging()
```
    Returns true if field deepPaging is set (has been assigned a value) and false otherwise
  - setDeepPagingIsSet
```
public void setDeepPagingIsSet(boolean value)
```
  - getDisableFunctionsSize
```
public int getDisableFunctionsSize()
```
  - putToDisableFunctions
```
public void putToDisableFunctions(java.lang.String key,
                                  java.lang.String val)
```
  - getDisableFunctions
```
public java.util.Map<java.lang.String,java.lang.String> getDisableFunctions()
```
    关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2... 3、如果要关闭多个function可以用“,”分隔，例如：disableValue="qp:function_name1:index_name1,qp:function_name2:index_name1" qp有如下模块： 1、spell_check: 检查用户查询串中的拼写错误，并给出纠错建议。 2、term_weighting: 分析查询中每个词的重要程度，并将其量化成权重，权重较低的词可能不会参与召回。 3、stop_word: 根据系统内置的停用词典过滤查询中无意义的词 4、synonym: 根据系统提供的通用同义词库和语义模型，对查询串进行同义词扩展，以便扩大召回。 example: "qp" 标示关闭整个qp "qp:spell_check" 标示关闭qp的拼音纠错功能。 "qp:stop_word:index_name1|index_name2" 标示关闭qp中index_name1和index_name2上的停用词功能。 key 需要禁用的函数名称 value 待禁用函数的详细说明
  - setDisableFunctions
```
public SearchParams setDisableFunctions(java.util.Map<java.lang.String,java.lang.String> disableFunctions)
```
    关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2... 3、如果要关闭多个function可以用“,”分隔，例如：disableValue="qp:function_name1:index_name1,qp:function_name2:index_name1" qp有如下模块： 1、spell_check: 检查用户查询串中的拼写错误，并给出纠错建议。 2、term_weighting: 分析查询中每个词的重要程度，并将其量化成权重，权重较低的词可能不会参与召回。 3、stop_word: 根据系统内置的停用词典过滤查询中无意义的词 4、synonym: 根据系统提供的通用同义词库和语义模型，对查询串进行同义词扩展，以便扩大召回。 example: "qp" 标示关闭整个qp "qp:spell_check" 标示关闭qp的拼音纠错功能。 "qp:stop_word:index_name1|index_name2" 标示关闭qp中index_name1和index_name2上的停用词功能。 key 需要禁用的函数名称 value 待禁用函数的详细说明
  - unsetDisableFunctions
```
public void unsetDisableFunctions()
```
  - isSetDisableFunctions
```
public boolean isSetDisableFunctions()
```
    Returns true if field disableFunctions is set (has been assigned a value) and false otherwise
  - setDisableFunctionsIsSet
```
public void setDisableFunctionsIsSet(boolean value)
```
  - getCustomParamSize
```
public int getCustomParamSize()
```
  - putToCustomParam
```
public void putToCustomParam(java.lang.String key,
                             java.lang.String val)
```
  - getCustomParam
```
public java.util.Map<java.lang.String,java.lang.String> getCustomParam()
```
  - setCustomParam
```
public SearchParams setCustomParam(java.util.Map<java.lang.String,java.lang.String> customParam)
```
  - unsetCustomParam
```
public void unsetCustomParam()
```
  - isSetCustomParam
```
public boolean isSetCustomParam()
```
    Returns true if field customParam is set (has been assigned a value) and false otherwise
  - setCustomParamIsSet
```
public void setCustomParamIsSet(boolean value)
```
  - getSuggest
```
public Suggest getSuggest()
```
    下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
  - setSuggest
```
public SearchParams setSuggest(Suggest suggest)
```
    下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
  - unsetSuggest
```
public void unsetSuggest()
```
  - isSetSuggest
```
public boolean isSetSuggest()
```
    Returns true if field suggest is set (has been assigned a value) and false otherwise
  - setSuggestIsSet
```
public void setSuggestIsSet(boolean value)
```
  - getAbtest
```
public Abtest getAbtest()
```
    Abtest
  - setAbtest
```
public SearchParams setAbtest(Abtest abtest)
```
    Abtest
  - unsetAbtest
```
public void unsetAbtest()
```
  - isSetAbtest
```
public boolean isSetAbtest()
```
    Returns true if field abtest is set (has been assigned a value) and false otherwise
  - setAbtestIsSet
```
public void setAbtestIsSet(boolean value)
```
  - getUserId
```
public java.lang.String getUserId()
```
    终端用户的id，用来统计uv信息
  - setUserId
```
public SearchParams setUserId(java.lang.String userId)
```
    终端用户的id，用来统计uv信息
  - unsetUserId
```
public void unsetUserId()
```
  - isSetUserId
```
public boolean isSetUserId()
```
    Returns true if field userId is set (has been assigned a value) and false otherwise
  - setUserIdIsSet
```
public void setUserIdIsSet(boolean value)
```
  - getRawQuery
```
public java.lang.String getRawQuery()
```
    终端用户输入的query
  - setRawQuery
```
public SearchParams setRawQuery(java.lang.String rawQuery)
```
    终端用户输入的query
  - unsetRawQuery
```
public void unsetRawQuery()
```
  - isSetRawQuery
```
public boolean isSetRawQuery()
```
    Returns true if field rawQuery is set (has been assigned a value) and false otherwise
  - setRawQueryIsSet
```
public void setRawQueryIsSet(boolean value)
```
  - getFinalDistinct
```
public FinalDistinct getFinalDistinct()
```
    精排聚合打散条件
  - setFinalDistinct
```
public SearchParams setFinalDistinct(FinalDistinct finalDistinct)
```
    精排聚合打散条件
  - unsetFinalDistinct
```
public void unsetFinalDistinct()
```
  - isSetFinalDistinct
```
public boolean isSetFinalDistinct()
```
    Returns true if field finalDistinct is set (has been assigned a value) and false otherwise
  - setFinalDistinctIsSet
```
public void setFinalDistinctIsSet(boolean value)
```
  - getCustomClauseSize
```
public int getCustomClauseSize()
```
  - putToCustomClause
```
public void putToCustomClause(java.lang.String key,
                              java.lang.String val)
```
  - getCustomClause
```
public java.util.Map<java.lang.String,java.lang.String> getCustomClause()
```
    自定义查询子句
  - setCustomClause
```
public SearchParams setCustomClause(java.util.Map<java.lang.String,java.lang.String> customClause)
```
    自定义查询子句
  - unsetCustomClause
```
public void unsetCustomClause()
```
  - isSetCustomClause
```
public boolean isSetCustomClause()
```
    Returns true if field customClause is set (has been assigned a value) and false otherwise
  - setCustomClauseIsSet
```
public void setCustomClauseIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(SearchParams._Fields field,
                          java.lang.Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - getFieldValue
```
public java.lang.Object getFieldValue(SearchParams._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - isSet
```
public boolean isSet(SearchParams._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - equals
```
public boolean equals(java.lang.Object that)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(SearchParams that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(SearchParams other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<SearchParams>
  - fieldForId
```
public SearchParams._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - write
```
public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
```
    Specified by:
    
    write in interface org.apache.thrift.TBase<SearchParams,SearchParams._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - validate
```
public void validate()
              throws org.apache.thrift.TException
```
    Throws:
    
    org.apache.thrift.TException

Class SearchParams

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

query

filter

sort

rank

aggregates

distincts

summaries

queryProcessorNames

deepPaging

disableFunctions

customParam

suggest

abtest

userId

rawQuery

finalDistinct

customClause

metaDataMap

Constructor Detail

SearchParams

SearchParams

SearchParams

Method Detail

deepCopy

clear

getConfig

setConfig

unsetConfig

isSetConfig

setConfigIsSet

getQuery

setQuery

unsetQuery

isSetQuery

setQueryIsSet

getFilter

setFilter

unsetFilter

isSetFilter

setFilterIsSet

getSort

setSort

unsetSort

isSetSort

setSortIsSet

getRank

setRank

unsetRank

isSetRank

setRankIsSet

getAggregatesSize

getAggregatesIterator

addToAggregates

getAggregates

setAggregates

unsetAggregates

isSetAggregates

setAggregatesIsSet

getDistinctsSize

getDistinctsIterator

addToDistincts

getDistincts

setDistincts

unsetDistincts

isSetDistincts

setDistinctsIsSet

getSummariesSize

getSummariesIterator

addToSummaries

getSummaries

setSummaries

unsetSummaries