org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* 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.pipeline;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.search.aggregations.AbstractAggregationBuilder;
import java.io.IOException;
import java.util.Map;
/**
* A base class for all pipeline aggregator builders.
*/
public abstract class PipelineAggregatorBuilder> extends AbstractAggregationBuilder {
private String[] bucketsPaths;
private Map metaData;
/**
* Sole constructor, typically used by sub-classes.
*/
protected PipelineAggregatorBuilder(String name, String type) {
super(name, type);
}
/**
* Sets the paths to the buckets to use for this pipeline aggregator
*/
public B setBucketsPaths(String... bucketsPaths) {
this.bucketsPaths = bucketsPaths;
return (B) this;
}
/**
* Sets the meta data to be included in the pipeline 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);
if (bucketsPaths != null) {
builder.startArray(PipelineAggregator.Parser.BUCKETS_PATH.getPreferredName());
for (String path : bucketsPaths) {
builder.value(path);
}
builder.endArray();
}
internalXContent(builder, params);
builder.endObject();
return builder.endObject();
}
protected abstract XContentBuilder internalXContent(XContentBuilder builder, Params params) throws IOException;
}