Package org.elasticsearch.search.aggregations.pipeline.serialdiff

Class SerialDiffPipelineAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

org.elasticsearch.search.aggregations.pipeline.serialdiff.SerialDiffPipelineAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class SerialDiffPipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	AGGREGATION_NAME_FIELD
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

BUCKETS_PATH_FIELD, metaData, type

Fields inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

bucketsPaths, name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SerialDiffPipelineAggregationBuilder(java.lang.String name, java.lang.String bucketsPath)
SerialDiffPipelineAggregationBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected PipelineAggregator	createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected void	doWriteTo(StreamOutput out)
java.lang.String	format()	Gets the format to use on the output of this aggregation.
SerialDiffPipelineAggregationBuilder	format(java.lang.String format)	Sets the format to use on the output of this aggregation.
protected DocValueFormat	formatter()
BucketHelpers.GapPolicy	gapPolicy()	Gets the GapPolicy to use on the output of this aggregation.
SerialDiffPipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)	Sets the GapPolicy to use on the output of this aggregation.
java.lang.String	getWriteableName()	Returns the name of the writeable object
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
int	lag()	Gets the lag to use when calculating the serial difference.
SerialDiffPipelineAggregationBuilder	lag(int lag)	Sets the lag to use when calculating the serial difference.
static SerialDiffPipelineAggregationBuilder	parse(java.lang.String reducerName, XContentParser parser)

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

create, doValidate, equals, getType, hashCode, overrideBucketsPath, setMetaData, toXContent, type, validate, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

getBucketsPaths, getName, subAggregations, toString

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

AGGREGATION_NAME_FIELD

public static final ParseField AGGREGATION_NAME_FIELD

Constructor Detail

SerialDiffPipelineAggregationBuilder

public SerialDiffPipelineAggregationBuilder(java.lang.String name,
                                            java.lang.String bucketsPath)

SerialDiffPipelineAggregationBuilder

public SerialDiffPipelineAggregationBuilder(StreamInput in)
                                     throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

Throws:

java.io.IOException

lag

public SerialDiffPipelineAggregationBuilder lag(int lag)

Sets the lag to use when calculating the serial difference.

lag

public int lag()

Gets the lag to use when calculating the serial difference.

format

public SerialDiffPipelineAggregationBuilder format(java.lang.String format)

Sets the format to use on the output of this aggregation.

format

public java.lang.String format()

Gets the format to use on the output of this aggregation.

gapPolicy

public SerialDiffPipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

Sets the GapPolicy to use on the output of this aggregation.

gapPolicy

public BucketHelpers.GapPolicy gapPolicy()

Gets the GapPolicy to use on the output of this aggregation.

formatter

protected DocValueFormat formatter()

createInternal

protected PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
                                     throws java.io.IOException

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

Throws:

java.io.IOException

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws java.io.IOException

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

Throws:

java.io.IOException

parse

public static SerialDiffPipelineAggregationBuilder parse(java.lang.String reducerName,
                                                         XContentParser parser)
                                                  throws java.io.IOException

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractPipelineAggregationBuilder<SerialDiffPipelineAggregationBuilder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object