File: search_aggs_metrics_percentile_ranks.go

package info (click to toggle)
golang-gopkg-olivere-elastic.v5 5.0.83-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 2,848 kB
  • sloc: makefile: 18; sh: 2
file content (131 lines) | stat: -rw-r--r-- 3,380 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// Copyright 2012-present Oliver Eilhard. All rights reserved.
// Use of this source code is governed by a MIT-license.
// See http://olivere.mit-license.org/license.txt for details.

package elastic

// PercentileRanksAggregation
// See: https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations-metrics-percentile-rank-aggregation.html
type PercentileRanksAggregation struct {
	field           string
	script          *Script
	format          string
	subAggregations map[string]Aggregation
	meta            map[string]interface{}
	values          []float64
	compression     *float64
	estimator       string
}

func NewPercentileRanksAggregation() *PercentileRanksAggregation {
	return &PercentileRanksAggregation{
		subAggregations: make(map[string]Aggregation),
		values:          make([]float64, 0),
	}
}

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

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

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

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

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

func (a *PercentileRanksAggregation) Values(values ...float64) *PercentileRanksAggregation {
	a.values = append(a.values, values...)
	return a
}

func (a *PercentileRanksAggregation) Compression(compression float64) *PercentileRanksAggregation {
	a.compression = &compression
	return a
}

func (a *PercentileRanksAggregation) Estimator(estimator string) *PercentileRanksAggregation {
	a.estimator = estimator
	return a
}

func (a *PercentileRanksAggregation) Source() (interface{}, error) {
	// Example:
	//	{
	//    "aggs" : {
	//      "load_time_outlier" : {
	//         "percentile_ranks" : {
	//           "field" : "load_time"
	//           "values" : [15, 30]
	//         }
	//       }
	//    }
	//	}
	// This method returns only the
	//   { "percentile_ranks" : { "field" : "load_time", "values" : [15, 30] } }
	// part.

	source := make(map[string]interface{})
	opts := make(map[string]interface{})
	source["percentile_ranks"] = 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
	}
	if len(a.values) > 0 {
		opts["values"] = a.values
	}
	if a.compression != nil {
		opts["compression"] = *a.compression
	}
	if a.estimator != "" {
		opts["estimator"] = a.estimator
	}

	// 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
}