class Aggregations::Buckets::TermsAggregationBuilder
Elasticsearch Terms Aggregation
Constants
- ATTRIBUTES
Public Class Methods
new(name: @name = name.intern)
click to toggle source
@param [String] name : Aggregation name
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 14 def initialize name: @name = name.intern @type = :terms @query = { @name => { @type => {} } } end
Public Instance Methods
add_order(bucket_order)
click to toggle source
@param [Misc::BucketOrder] bucket_order @return [TermsAggregationBuilder], can be chained for ordering on multiple fields.
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 38 def add_order bucket_order @order ||= [] @order << bucket_order self end
exclude(exclude_list)
click to toggle source
@param [Array] exclude list @return [TermsAggregationBuilder]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 63 def exclude exclude_list @exclude = exclude_list self end
exclude_expr()
click to toggle source
@return [Array]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 69 def exclude_expr @exclude end
include(include_list)
click to toggle source
@param [Array] include list @return [TermsAggregationBuilder]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 51 def include include_list @include = include_list self end
include_expr()
click to toggle source
@return [Array]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 57 def include_expr @include end
min_doc_count(doc_count)
click to toggle source
@param [Integer] min doc count @return [TermsAggregationBuilder]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 75 def min_doc_count doc_count @min_doc_count = doc_count self end
min_doc_count_expr()
click to toggle source
@return [Integer]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 81 def min_doc_count_expr @min_doc_count end
order_expr()
click to toggle source
@return [Array]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 45 def order_expr @order end
size(size)
click to toggle source
@param [Integer] size @return [TermsAggregationBuilder]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 26 def size size @size = size self end
size_expr()
click to toggle source
@return [Integer]
# File lib/aggregations/buckets/terms_aggregation_builder.rb, line 32 def size_expr @size end