co.elastic.clients.elasticsearch.rollup.Groupings Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. 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 co.elastic.clients.elasticsearch.rollup;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: rollup._types.Groupings
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Groupings implements JsonpSerializable {
@Nullable
private final DateHistogramGrouping dateHistogram;
@Nullable
private final HistogramGrouping histogram;
@Nullable
private final TermsGrouping terms;
// ---------------------------------------------------------------------------------------------
private Groupings(Builder builder) {
this.dateHistogram = builder.dateHistogram;
this.histogram = builder.histogram;
this.terms = builder.terms;
}
public static Groupings of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* A date histogram group aggregates a date field into time-based buckets. This
* group is mandatory; you currently cannot roll up documents without a
* timestamp and a date_histogram group.
*
* API name: {@code date_histogram}
*/
@Nullable
public final DateHistogramGrouping dateHistogram() {
return this.dateHistogram;
}
/**
* The histogram group aggregates one or more numeric fields into numeric
* histogram intervals.
*
* API name: {@code histogram}
*/
@Nullable
public final HistogramGrouping histogram() {
return this.histogram;
}
/**
* The terms group can be used on keyword or numeric fields to allow bucketing
* via the terms aggregation at a later point. The indexer enumerates and stores
* all values of a field for each time-period. This can be potentially costly
* for high-cardinality groups such as IP addresses, especially if the
* time-bucket is particularly sparse.
*
* API name: {@code terms}
*/
@Nullable
public final TermsGrouping terms() {
return this.terms;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.dateHistogram != null) {
generator.writeKey("date_histogram");
this.dateHistogram.serialize(generator, mapper);
}
if (this.histogram != null) {
generator.writeKey("histogram");
this.histogram.serialize(generator, mapper);
}
if (this.terms != null) {
generator.writeKey("terms");
this.terms.serialize(generator, mapper);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Groupings}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private DateHistogramGrouping dateHistogram;
@Nullable
private HistogramGrouping histogram;
@Nullable
private TermsGrouping terms;
/**
* A date histogram group aggregates a date field into time-based buckets. This
* group is mandatory; you currently cannot roll up documents without a
* timestamp and a date_histogram group.
*
* API name: {@code date_histogram}
*/
public final Builder dateHistogram(@Nullable DateHistogramGrouping value) {
this.dateHistogram = value;
return this;
}
/**
* A date histogram group aggregates a date field into time-based buckets. This
* group is mandatory; you currently cannot roll up documents without a
* timestamp and a date_histogram group.
*
* API name: {@code date_histogram}
*/
public final Builder dateHistogram(
Function> fn) {
return this.dateHistogram(fn.apply(new DateHistogramGrouping.Builder()).build());
}
/**
* The histogram group aggregates one or more numeric fields into numeric
* histogram intervals.
*
* API name: {@code histogram}
*/
public final Builder histogram(@Nullable HistogramGrouping value) {
this.histogram = value;
return this;
}
/**
* The histogram group aggregates one or more numeric fields into numeric
* histogram intervals.
*
* API name: {@code histogram}
*/
public final Builder histogram(Function> fn) {
return this.histogram(fn.apply(new HistogramGrouping.Builder()).build());
}
/**
* The terms group can be used on keyword or numeric fields to allow bucketing
* via the terms aggregation at a later point. The indexer enumerates and stores
* all values of a field for each time-period. This can be potentially costly
* for high-cardinality groups such as IP addresses, especially if the
* time-bucket is particularly sparse.
*
* API name: {@code terms}
*/
public final Builder terms(@Nullable TermsGrouping value) {
this.terms = value;
return this;
}
/**
* The terms group can be used on keyword or numeric fields to allow bucketing
* via the terms aggregation at a later point. The indexer enumerates and stores
* all values of a field for each time-period. This can be potentially costly
* for high-cardinality groups such as IP addresses, especially if the
* time-bucket is particularly sparse.
*
* API name: {@code terms}
*/
public final Builder terms(Function> fn) {
return this.terms(fn.apply(new TermsGrouping.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Groupings}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Groupings build() {
_checkSingleUse();
return new Groupings(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Groupings}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Groupings::setupGroupingsDeserializer);
protected static void setupGroupingsDeserializer(ObjectDeserializer op) {
op.add(Builder::dateHistogram, DateHistogramGrouping._DESERIALIZER, "date_histogram");
op.add(Builder::histogram, HistogramGrouping._DESERIALIZER, "histogram");
op.add(Builder::terms, TermsGrouping._DESERIALIZER, "terms");
}
}