org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder Maven / Gradle / Ivy
The newest version!
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.search.aggregations.metrics;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.search.aggregations.AbstractAggregationBuilder;
import java.io.IOException;
import java.util.Map;
/**
* Base builder for metrics aggregations.
*/
public abstract class MetricsAggregationBuilder> extends AbstractAggregationBuilder {
private Map metaData;
public MetricsAggregationBuilder(String name, String type) {
super(name, type);
}
/**
* Sets the meta data to be included in the metric aggregator's response
*/
public B setMetaData(Map metaData) {
this.metaData = metaData;
return (B) this;
}
@Override
public final XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(getName());
if (this.metaData != null) {
builder.field("meta", this.metaData);
}
builder.startObject(type);
internalXContent(builder, params);
return builder.endObject().endObject();
}
protected abstract void internalXContent(XContentBuilder builder, Params params) throws IOException;
}