Class: JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation

Inherits:

Object

• Object
• JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation

Defined in:

lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb

Overview

Base class for all Elasticsearch aggregation types. For more information on what types of aggregations are available see: www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html

Direct Known Subclasses

Avg, Cardinality, Composite, DateHistogram, Filter, Max, ScriptedMetric, Sum, Terms, TopHits, ValueCount

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

Instance Method Summary

• #aggs {|The| ... } ⇒ JayAPI::Elasticsearch::QueryBuilder::Aggregations, self

  Creates nested aggregations inside the receiver.

• #clone ⇒ Object
• #initialize(name) ⇒ Aggregation constructor

  A new instance of Aggregation.

Constructor Details

#initialize(name) ⇒ Aggregation

Returns a new instance of Aggregation.

Parameters:

• name (String) —

  The name used by Elasticsearch to identify each of the aggregations.

# File 'lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb', line 17

def initialize(name)
  @name = name
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb', line 13

def name
  @name
end

Instance Method Details

#aggs {|The| ... } ⇒ JayAPI::Elasticsearch::QueryBuilder::Aggregations, self

Creates nested aggregations inside the receiver.

Yield Parameters:

• The (JayAPI::Elasticsearch::QueryBuilder::Aggregations) —

  receiver’s nested aggregations object.

Returns:

• (JayAPI::Elasticsearch::QueryBuilder::Aggregations, self) —

  If no block is given then the nested aggregations are returned instead of yielded. If a block is given then the receiver is returned.

# File 'lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb', line 28

def aggs(&block)
  aggregations = self.aggregations ||= ::JayAPI::Elasticsearch::QueryBuilder::Aggregations.new
  return aggregations unless block

  block.call(aggregations)
  self
end

#clone ⇒ Object

Raises:

• (NotImplementedError) —

  Is always raised. The child classes must override the method.

# File 'lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb', line 38

def clone
  raise NotImplementedError, "Please implement #{__method__} in #{self.class}"
end