Method: Orchestrate::Search::TopValuesBuilder#initialize

Defined in:
lib/orchestrate/search/aggregate_builder.rb

#initialize(builder, field_name, offset = nil, limit = nil) ⇒ TopValuesBuilder

Initialize a new TopValuesBuilder object If omitted, uses the server default value of zero. If omitted, uses the server default value of ten.

Parameters:

  • builder (AggregateBuilder) —

    The Aggregate Builder object

  • field_name (#to_s) —

    The field to operate over

  • offset (Integer, nil) (defaults to: nil) —

    The zero-based index of the first paged value to retrieve in this aggregation.

  • limit (Integer, nil) (defaults to: nil) —

    The maximum number of values to retrieve per page of results for this aggregation.



104
105
106
107
108
109
110
111
112
 
# File 'lib/orchestrate/search/aggregate_builder.rb', line 104

def initialize(builder, field_name, offset=nil, limit=nil)
  @builder = builder
  @field_name = field_name
  if offset.nil? ^ limit.nil?
    raise ArgumentError, "offset and limit arguments can only be supplied together, or not at all"
  end
  @offset = offset
  @limit = limit
end