elastic-builder/lib/aggregations/pipeline-aggregations/bucket-selector-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-bucket-selector-aggregation.html';

/**
 * A parent pipeline aggregation which executes a script which determines whether
 * the current bucket will be retained in the parent multi-bucket aggregation.
 * The specified metric must be numeric and the script must return a boolean value.
 * If the script language is expression then a numeric return value is permitted.
 * In this case 0.0 will be evaluated as false and all other values will evaluate to true.
 *
 * [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html)
 *
 * @example
 * const reqBody = esb.requestBodySearch()
 *     .agg(
 *         esb.dateHistogramAggregation('histo', 'date')
 *             .interval('day')
 *             .agg(esb.termsAggregation('categories', 'category'))
 *             .agg(
 *                 esb.bucketSelectorAggregation('min_bucket_selector')
 *                     .bucketsPath({ count: 'categories._bucket_count' })
 *                     .script(esb.script('inline', 'params.count != 0'))
 *             )
 *     )
 *     .size(0);
 *
 * @example
 * const reqBody = esb.requestBodySearch()
 *     .agg(
 *         esb.dateHistogramAggregation('sales_per_month', 'date')
 *             .interval('month')
 *             .agg(esb.sumAggregation('sales', 'price'))
 *             .agg(
 *                 esb.bucketSelectorAggregation('sales_bucket_filter')
 *                     .bucketsPath({ totalSales: 'total_sales' })
 *                     .script('params.totalSales > 200')
 *             )
 *     )
 *     .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 BucketSelectorAggregation = function (_PipelineAggregationB) {
    (0, _inherits3.default)(BucketSelectorAggregation, _PipelineAggregationB);

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

    /**
     * @override
     * @throws {Error} This method cannot be called on BucketSelectorAggregation
     */


    (0, _createClass3.default)(BucketSelectorAggregation, [{
        key: 'format',
        value: function format() {
            console.log('Please refer ' + ES_REF_URL);
            throw new Error('format is not supported in BucketSelectorAggregation');
        }

        /**
         * Sets script parameter for aggregation. Required.
         *
         * @param {Script|string} script
         * @returns {BucketSelectorAggregation} returns `this` so that calls can be chained
         * @throws {TypeError} If `script` is not an instance of `Script`
         */

    }, {
        key: 'script',
        value: function script(_script) {
            this._aggsDef.script = _script;
            return this;
        }
    }]);
    return BucketSelectorAggregation;
}(PipelineAggregationBase);

module.exports = BucketSelectorAggregation;