@jmaitrehenry/elastic-builder/lib/aggregations/pipeline-aggregations/extended-stats-bucket-aggregation.js

A JavaScript implementation of the elasticsearch Query DSL

'use strict';

var _classCallCheck2 = require('babel-runtime/helpers/classCallCheck');

var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);

var _createClass2 = require('babel-runtime/helpers/createClass');

var _createClass3 = _interopRequireDefault(_createClass2);

var _possibleConstructorReturn2 = require('babel-runtime/helpers/possibleConstructorReturn');

var _possibleConstructorReturn3 = _interopRequireDefault(_possibleConstructorReturn2);

var _inherits2 = require('babel-runtime/helpers/inherits');

var _inherits3 = _interopRequireDefault(_inherits2);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

var PipelineAggregationBase = require('./pipeline-aggregation-base');

var ES_REF_URL = 'https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html';

/**
 * A sibling pipeline aggregation which calculates a variety of stats across
 * all bucket of a specified metric in a sibling aggregation. The specified
 * metric must be numeric and the sibling aggregation must be a multi-bucket
 * aggregation.
 *
 * [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html)
 *
 * @example
 * const reqBody = esb.requestBodySearch()
 *     .agg(
 *         esb.dateHistogramAggregation('sales_per_month', 'date')
 *             .interval('month')
 *             .agg(esb.sumAggregation('sales', 'price'))
 *     )
 *     .agg(
 *         // Calculates extended stats for monthly sales
 *         esb.extendedStatsBucketAggregation(
 *             'stats_monthly_sales',
 *             'sales_per_month>sales'
 *         )
 *     )
 *     .size(0);
 *
 * @param {string} name The name which will be used to refer to this aggregation.
 * @param {string=} bucketsPath The relative path of metric to aggregate over
 *
 * @extends PipelineAggregationBase
 */

var ExtendedStatsBucketAggregation = function (_PipelineAggregationB) {
    (0, _inherits3.default)(ExtendedStatsBucketAggregation, _PipelineAggregationB);

    // eslint-disable-next-line require-jsdoc
    function ExtendedStatsBucketAggregation(name, bucketsPath) {
        (0, _classCallCheck3.default)(this, ExtendedStatsBucketAggregation);
        return (0, _possibleConstructorReturn3.default)(this, (ExtendedStatsBucketAggregation.__proto__ || Object.getPrototypeOf(ExtendedStatsBucketAggregation)).call(this, name, 'extended_stats_bucket', ES_REF_URL, bucketsPath));
    }

    /**
     * Sets the number of standard deviations above/below the mean to display.
     * Optional.
     *
     * @param {number} sigma Default is 2.
     * @returns {ExtendedStatsBucketAggregation} returns `this` so that calls can be chained
     */


    (0, _createClass3.default)(ExtendedStatsBucketAggregation, [{
        key: 'sigma',
        value: function sigma(_sigma) {
            this._aggsDef.sigma = _sigma;
            return this;
        }
    }]);
    return ExtendedStatsBucketAggregation;
}(PipelineAggregationBase);

module.exports = ExtendedStatsBucketAggregation;