Package org.elasticsearch.client.rollup.job.config

Class GroupConfig

java.lang.Object

org.elasticsearch.client.rollup.job.config.GroupConfig

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class GroupConfig
extends java.lang.Object
implements Validatable, ToXContentObject

The configuration object for the groups section in the rollup config. Basically just a wrapper for histo/date histo/terms objects { "groups": [ "date_histogram": {...}, "histogram" : {...}, "terms" : {...} ] }

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
GroupConfig(DateHistogramGroupConfig dateHistogram)
GroupConfig(DateHistogramGroupConfig dateHistogram, HistogramGroupConfig histogram, TermsGroupConfig terms)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
static GroupConfig	fromXContent(XContentParser parser)
DateHistogramGroupConfig	getDateHistogram()
HistogramGroupConfig	getHistogram()
TermsGroupConfig	getTerms()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.util.Optional<ValidationException>	validate()	Perform validation.

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

GroupConfig

public GroupConfig(DateHistogramGroupConfig dateHistogram)

GroupConfig

public GroupConfig(DateHistogramGroupConfig dateHistogram,
                   @Nullable
                   HistogramGroupConfig histogram,
                   @Nullable
                   TermsGroupConfig terms)

Method Detail

validate

public java.util.Optional<ValidationException> validate()

Description copied from interface: Validatable

Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.

Specified by:

validate in interface Validatable

Returns:

An Optional ValidationException that contains a list of validation errors.

getDateHistogram

public DateHistogramGroupConfig getDateHistogram()

Returns:

the configuration of the date histogram

getHistogram

@Nullable
public HistogramGroupConfig getHistogram()

Returns:

the configuration of the histogram

getTerms

@Nullable
public TermsGroupConfig getTerms()

Returns:

the configuration of the terms

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromXContent

public static GroupConfig fromXContent(XContentParser parser)
                                throws java.io.IOException

Throws:

java.io.IOException