Debian Codegraph @

search_aggs_pipeline_stats_bucket.go

raw
1 // Copyright 2012-present Oliver Eilhard. All rights reserved.
2 // Use of this source code is governed by a MIT-license.
3 // See http://olivere.mit-license.org/license.txt for details.
4
5 package elastic
6
7 // StatsBucketAggregation is a sibling pipeline aggregation which calculates
8 // a variety of stats across all bucket of a specified metric in a sibling aggregation.
9 // The specified metric must be numeric and the sibling aggregation must
10 // be a multi-bucket aggregation.
11 //
12 // For more details, see
13 // https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations-pipeline-stats-bucket-aggregation.html
14 type StatsBucketAggregation struct {
15 format string
16 gapPolicy string
17
18 subAggregations map[string]Aggregation
19 meta map[string]interface{}
20 bucketsPaths []string
21 }
22
23 // NewStatsBucketAggregation creates and initializes a new StatsBucketAggregation.
24 func NewStatsBucketAggregation() *StatsBucketAggregation {
25 return &StatsBucketAggregation{
26 subAggregations: make(map[string]Aggregation),
27 bucketsPaths: make([]string, 0),
28 }
29 }
30
31 func (s *StatsBucketAggregation) Format(format string) *StatsBucketAggregation {
32 s.format = format
33 return s
34 }
35
36 // GapPolicy defines what should be done when a gap in the series is discovered.
37 // Valid values include "insert_zeros" or "skip". Default is "insert_zeros".
38 func (s *StatsBucketAggregation) GapPolicy(gapPolicy string) *StatsBucketAggregation {
39 s.gapPolicy = gapPolicy
40 return s
41 }
42
43 // GapInsertZeros inserts zeros for gaps in the series.
44 func (s *StatsBucketAggregation) GapInsertZeros() *StatsBucketAggregation {
45 s.gapPolicy = "insert_zeros"
46 return s
47 }
48
49 // GapSkip skips gaps in the series.
50 func (s *StatsBucketAggregation) GapSkip() *StatsBucketAggregation {
51 s.gapPolicy = "skip"
52 return s
53 }
54
55 // SubAggregation adds a sub-aggregation to this aggregation.
56 func (s *StatsBucketAggregation) SubAggregation(name string, subAggregation Aggregation) *StatsBucketAggregation {
57 s.subAggregations[name] = subAggregation
58 return s
59 }
60
61 // Meta sets the meta data to be included in the aggregation response.
62 func (s *StatsBucketAggregation) Meta(metaData map[string]interface{}) *StatsBucketAggregation {
63 s.meta = metaData
64 return s
65 }
66
67 // BucketsPath sets the paths to the buckets to use for this pipeline aggregator.
68 func (s *StatsBucketAggregation) BucketsPath(bucketsPaths ...string) *StatsBucketAggregation {
69 s.bucketsPaths = append(s.bucketsPaths, bucketsPaths...)
70 return s
71 }
72
73 func (s *StatsBucketAggregation) Source() (interface{}, error) {
74 source := make(map[string]interface{})
75 params := make(map[string]interface{})
76 source["stats_bucket"] = params
77
78 if s.format != "" {
79 params["format"] = s.format
80 }
81 if s.gapPolicy != "" {
82 params["gap_policy"] = s.gapPolicy
83 }
84
85 // Add buckets paths
86 switch len(s.bucketsPaths) {
87 case 0:
88 case 1:
89 params["buckets_path"] = s.bucketsPaths[0]
90 default:
91 params["buckets_path"] = s.bucketsPaths
92 }
93
94 // AggregationBuilder (SubAggregations)
95 if len(s.subAggregations) > 0 {
96 aggsMap := make(map[string]interface{})
97 source["aggregations"] = aggsMap
98 for name, aggregate := range s.subAggregations {
99 src, err := aggregate.Source()
100 if err != nil {
101 return nil, err
102 }
103 aggsMap[name] = src
104 }
105 }
106
107 // Add Meta data if available
108 if len(s.meta) > 0 {
109 source["meta"] = s.meta
110 }
111
112 return source, nil
113 }