aggs_metrics_min.go

package aggretastic

import "github.com/olivere/elastic/v7"

// MinAggregation is a single-value metrics aggregation that keeps track and
// returns the minimum value among numeric values extracted from the
// aggregated documents. These values can be extracted either from
// specific numeric fields in the documents, or be generated by a
// provided script.
// See: https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations-metrics-min-aggregation.html
type MinAggregation struct {
	*tree

	field  string
	script *elastic.Script
	format string
	meta   map[string]interface{}
}

func NewMinAggregation() *MinAggregation {
	a := &MinAggregation{}
	a.tree = nilAggregationTree(a)

	return a
}

func (a *MinAggregation) Field(field string) *MinAggregation {
	a.field = field
	return a
}

func (a *MinAggregation) Script(script *elastic.Script) *MinAggregation {
	a.script = script
	return a
}

func (a *MinAggregation) Format(format string) *MinAggregation {
	a.format = format
	return a
}

func (a *MinAggregation) SubAggregation(name string, subAggregation Aggregation) *MinAggregation {
	a.subAggregations[name] = subAggregation
	return a
}

// Meta sets the meta data to be included in the aggregation response.
func (a *MinAggregation) Meta(metaData map[string]interface{}) *MinAggregation {
	a.meta = metaData
	return a
}

func (a *MinAggregation) Source() (interface{}, error) {
	// Example:
	//	{
	//    "aggs" : {
	//      "min_price" : { "min" : { "field" : "price" } }
	//    }
	//	}
	// This method returns only the { "min" : { "field" : "price" } } part.

	source := make(map[string]interface{})
	opts := make(map[string]interface{})
	source["min"] = opts

	// ValuesSourceAggregationBuilder
	if a.field != "" {
		opts["field"] = a.field
	}
	if a.script != nil {
		src, err := a.script.Source()
		if err != nil {
			return nil, err
		}
		opts["script"] = src
	}
	if a.format != "" {
		opts["format"] = a.format
	}

	// AggregationBuilder (SubAggregations)
	if len(a.subAggregations) > 0 {
		aggsMap := make(map[string]interface{})
		source["aggregations"] = aggsMap
		for name, aggregate := range a.subAggregations {
			src, err := aggregate.Source()
			if err != nil {
				return nil, err
			}
			aggsMap[name] = src
		}
	}

	// Add Meta data if available
	if len(a.meta) > 0 {
		source["meta"] = a.meta
	}

	return source, nil
}