class Aggregations::Buckets::TopHitsAggregationBuilder

Elasticsearch Top Hits Aggregation

Constants

ATTRIBUTES

Public Class Methods

new(name: @name = name.intern) click to toggle source

@param [String] name : Aggregation name

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 13
def initialize name:
  @name = name.intern
  @type = :top_hits
  @query = {
    @name => {
      @type => {}
    }
  }
end

Public Instance Methods

add_sort(sort) click to toggle source

@param [Sort::SortBuilder] sort : use SortBuilders factory @return [TopHitsAggregationBuilder]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 37
def add_sort sort
  @sort ||= []
  @sort << sort
  self
end
size(size) click to toggle source

@param [Integer] size @return [TopHitsAggregationBuilder]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 25
def size size
  @size = size
  self
end
size_expr() click to toggle source

@return [Integer]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 31
def size_expr
  @size
end
sort_expr() click to toggle source

@return [Sort::SortBuilder]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 44
def sort_expr
  @sort
end
source_exclude(exclude_list) click to toggle source

@param [Array] exclude_list @return [TopHitsAggregationBuilder]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 58
def source_exclude exclude_list
  @_source ||= {}
  @_source[:exclude] = exclude_list if exclude_list.present?
  self
end
source_exclude_expr() click to toggle source

@return [Array]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 71
def source_exclude_expr
  return [] unless @_source.present?
  @_source[:exclude]
end
source_include(include_list) click to toggle source

@param [Array] include_list @return [TopHitsAggregationBuilder]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 50
def source_include include_list
  @_source ||= {}
  @_source[:include] = include_list if include_list.present?
  self
end
source_include_expr() click to toggle source

@return [Array]

# File lib/aggregations/buckets/top_hits_aggregation_builder.rb, line 65
def source_include_expr
  return [] unless @_source.present?
  @_source[:include]
end