summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go')
-rw-r--r--vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go113
1 files changed, 113 insertions, 0 deletions
diff --git a/vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go b/vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go
new file mode 100644
index 000000000..c22ae8f50
--- /dev/null
+++ b/vendor/github.com/olivere/elastic/search_aggs_pipeline_sum_bucket.go
@@ -0,0 +1,113 @@
+// 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
+
+// SumBucketAggregation is a sibling pipeline aggregation which calculates
+// the sum across all buckets of a specified metric in a sibling aggregation.
+// The specified metric must be numeric and the sibling aggregation must
+// be a multi-bucket aggregation.
+//
+// For more details, see
+// https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-aggregations-pipeline-sum-bucket-aggregation.html
+type SumBucketAggregation struct {
+ format string
+ gapPolicy string
+
+ subAggregations map[string]Aggregation
+ meta map[string]interface{}
+ bucketsPaths []string
+}
+
+// NewSumBucketAggregation creates and initializes a new SumBucketAggregation.
+func NewSumBucketAggregation() *SumBucketAggregation {
+ return &SumBucketAggregation{
+ subAggregations: make(map[string]Aggregation),
+ bucketsPaths: make([]string, 0),
+ }
+}
+
+func (a *SumBucketAggregation) Format(format string) *SumBucketAggregation {
+ a.format = format
+ return a
+}
+
+// GapPolicy defines what should be done when a gap in the series is discovered.
+// Valid values include "insert_zeros" or "skip". Default is "insert_zeros".
+func (a *SumBucketAggregation) GapPolicy(gapPolicy string) *SumBucketAggregation {
+ a.gapPolicy = gapPolicy
+ return a
+}
+
+// GapInsertZeros inserts zeros for gaps in the series.
+func (a *SumBucketAggregation) GapInsertZeros() *SumBucketAggregation {
+ a.gapPolicy = "insert_zeros"
+ return a
+}
+
+// GapSkip skips gaps in the series.
+func (a *SumBucketAggregation) GapSkip() *SumBucketAggregation {
+ a.gapPolicy = "skip"
+ return a
+}
+
+// SubAggregation adds a sub-aggregation to this aggregation.
+func (a *SumBucketAggregation) SubAggregation(name string, subAggregation Aggregation) *SumBucketAggregation {
+ a.subAggregations[name] = subAggregation
+ return a
+}
+
+// Meta sets the meta data to be included in the aggregation response.
+func (a *SumBucketAggregation) Meta(metaData map[string]interface{}) *SumBucketAggregation {
+ a.meta = metaData
+ return a
+}
+
+// BucketsPath sets the paths to the buckets to use for this pipeline aggregator.
+func (a *SumBucketAggregation) BucketsPath(bucketsPaths ...string) *SumBucketAggregation {
+ a.bucketsPaths = append(a.bucketsPaths, bucketsPaths...)
+ return a
+}
+
+func (a *SumBucketAggregation) Source() (interface{}, error) {
+ source := make(map[string]interface{})
+ params := make(map[string]interface{})
+ source["sum_bucket"] = params
+
+ if a.format != "" {
+ params["format"] = a.format
+ }
+ if a.gapPolicy != "" {
+ params["gap_policy"] = a.gapPolicy
+ }
+
+ // Add buckets paths
+ switch len(a.bucketsPaths) {
+ case 0:
+ case 1:
+ params["buckets_path"] = a.bucketsPaths[0]
+ default:
+ params["buckets_path"] = a.bucketsPaths
+ }
+
+ // 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
+}