TermsBuilder (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.search.aggregations.AbstractAggregationBuilder
- - org.elasticsearch.search.aggregations.AggregationBuilder<B>
  - - org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder<TermsBuilder>
    - - org.elasticsearch.search.aggregations.bucket.terms.TermsBuilder

すべての実装されたインタフェース:

ToXContent
```
public class TermsBuilder
extends ValuesSourceAggregationBuilder<TermsBuilder>
```
Builder for the Terms aggregation.

ネストされたクラスのサマリー
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー
- クラスから継承されたフィールド org.elasticsearch.search.aggregations.AbstractAggregationBuilder
  type
- インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

TermsBuilder(String name)
Sole constructor.

コンストラクタ
コンストラクタと説明
`TermsBuilder(String name)` Sole constructor.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`TermsBuilder`	`collectMode(Aggregator.SubAggCollectionMode mode)` Expert: set the collection mode.
`protected XContentBuilder`	`doInternalXContent(XContentBuilder builder, ToXContent.Params params)`
`TermsBuilder`	`exclude(double[] terms)` Define a set of terms that should not be aggregated.
`TermsBuilder`	`exclude(long[] terms)` Define a set of terms that should not be aggregated.
`TermsBuilder`	`exclude(String regex)` Define a regular expression that will filter out terms that should be excluded from the aggregation.
`TermsBuilder`	`exclude(String[] terms)` Define a set of terms that should not be aggregated.
`TermsBuilder`	`executionHint(String executionHint)` Expert: provide an execution hint to the aggregation.
`TermsBuilder`	`include(double[] terms)` Define a set of terms that should be aggregated.
`TermsBuilder`	`include(long[] terms)` Define a set of terms that should be aggregated.
`TermsBuilder`	`include(String regex)` Define a regular expression that will determine what terms should be aggregated.
`TermsBuilder`	`include(String[] terms)` Define a set of terms that should be aggregated.
`TermsBuilder`	`minDocCount(long minDocCount)` Set the minimum document count terms should have in order to appear in the response.
`TermsBuilder`	`order(Terms.Order order)` Defines the order in which the buckets will be returned.
`TermsBuilder`	`shardMinDocCount(long shardMinDocCount)` Set the minimum document count terms should have on the shard in order to appear in the response.
`TermsBuilder`	`shardSize(int shardSize)` Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution).
`TermsBuilder`	`showTermDocCountError(boolean showTermDocCountError)` Expert: return document count errors per term in the response.
`TermsBuilder`	`size(int size)` Sets the size - indicating how many term buckets should be returned (defaults to 10)
`TermsBuilder`	`valueType(Terms.ValueType valueType)` When using scripts, the value type indicates the types of the values the script is generating.

クラスから継承されたメソッド org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder
field, internalXContent, missing, script

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AggregationBuilder
setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AbstractAggregationBuilder
getName

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - TermsBuilder
```
public TermsBuilder(String name)
```
    Sole constructor.
- メソッドの詳細
  - size
```
public TermsBuilder size(int size)
```
    Sets the size - indicating how many term buckets should be returned (defaults to 10)
  - shardSize
```
public TermsBuilder shardSize(int shardSize)
```
    Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution). The higher the shard size is, the more accurate the results are.
  - minDocCount
```
public TermsBuilder minDocCount(long minDocCount)
```
    Set the minimum document count terms should have in order to appear in the response.
  - shardMinDocCount
```
public TermsBuilder shardMinDocCount(long shardMinDocCount)
```
    Set the minimum document count terms should have on the shard in order to appear in the response.
  - include
```
public TermsBuilder include(String regex)
```
    Define a regular expression that will determine what terms should be aggregated. The regular expression is based on the RegExp class.
    
    関連項目:
    
    RegExp.RegExp(String)
  - include
```
public TermsBuilder include(String[] terms)
```
    Define a set of terms that should be aggregated.
  - include
```
public TermsBuilder include(long[] terms)
```
    Define a set of terms that should be aggregated.
  - include
```
public TermsBuilder include(double[] terms)
```
    Define a set of terms that should be aggregated.
  - exclude
```
public TermsBuilder exclude(String regex)
```
    Define a regular expression that will filter out terms that should be excluded from the aggregation. The regular expression is based on the RegExp class.
    
    関連項目:
    
    RegExp.RegExp(String)
  - exclude
```
public TermsBuilder exclude(String[] terms)
```
    Define a set of terms that should not be aggregated.
  - exclude
```
public TermsBuilder exclude(long[] terms)
```
    Define a set of terms that should not be aggregated.
  - exclude
```
public TermsBuilder exclude(double[] terms)
```
    Define a set of terms that should not be aggregated.
  - valueType
```
public TermsBuilder valueType(Terms.ValueType valueType)
```
    When using scripts, the value type indicates the types of the values the script is generating.
  - order
```
public TermsBuilder order(Terms.Order order)
```
    Defines the order in which the buckets will be returned.
  - executionHint
```
public TermsBuilder executionHint(String executionHint)
```
    Expert: provide an execution hint to the aggregation.
  - collectMode
```
public TermsBuilder collectMode(Aggregator.SubAggCollectionMode mode)
```
    Expert: set the collection mode.
  - showTermDocCountError
```
public TermsBuilder showTermDocCountError(boolean showTermDocCountError)
```
    Expert: return document count errors per term in the response.
  - doInternalXContent
```
protected XContentBuilder doInternalXContent(XContentBuilder builder,
                                             ToXContent.Params params)
                                      throws IOException
```
    定義:
    
    doInternalXContent クラス内 ValuesSourceAggregationBuilder<TermsBuilder>
    
    例外:
    
    IOException

クラス TermsBuilder

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.search.aggregations.AbstractAggregationBuilder

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AggregationBuilder

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AbstractAggregationBuilder

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

TermsBuilder

メソッドの詳細

size

shardSize

minDocCount

shardMinDocCount

include

include

include

include

exclude

exclude

exclude

exclude

valueType

order

executionHint

collectMode

showTermDocCountError

doInternalXContent