co.elastic.clients.elasticsearch.ml.DataframeAnalyticsSource 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.mapping.RuntimeField;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
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.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml._types.DataframeAnalyticsSource
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeAnalyticsSource implements JsonpSerializable {
private final List index;
@Nullable
private final Query query;
private final Map> runtimeMappings;
@Nullable
private final DataframeAnalysisAnalyzedFields source;
// ---------------------------------------------------------------------------------------------
private DataframeAnalyticsSource(Builder builder) {
this.index = ApiTypeHelper.unmodifiableRequired(builder.index, this, "index");
this.query = builder.query;
this.runtimeMappings = ApiTypeHelper.unmodifiable(builder.runtimeMappings);
this.source = builder.source;
}
public static DataframeAnalyticsSource of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Index or indices on which to perform the analysis. It can be a
* single index or index pattern as well as an array of indices or patterns.
* NOTE: If your source indices contain documents with the same IDs, only the
* document that is indexed last appears in the destination index.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. By default, this property has the following
* value: {"match_all": {}}.
*
* API name: {@code query}
*/
@Nullable
public final Query query() {
return this.query;
}
/**
* Definitions of runtime fields that will become part of the mapping of the
* destination index.
*
* API name: {@code runtime_mappings}
*/
public final Map> runtimeMappings() {
return this.runtimeMappings;
}
/**
* Specify includes and/or `excludes patterns to select which
* fields will be present in the destination. Fields that are excluded cannot be
* included in the analysis.
*
* API name: {@code _source}
*/
@Nullable
public final DataframeAnalysisAnalyzedFields source() {
return this.source;
}
/**
* 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 (ApiTypeHelper.isDefined(this.index)) {
generator.writeKey("index");
generator.writeStartArray();
for (String item0 : this.index) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.runtimeMappings)) {
generator.writeKey("runtime_mappings");
generator.writeStartObject();
for (Map.Entry> item0 : this.runtimeMappings.entrySet()) {
generator.writeKey(item0.getKey());
generator.writeStartArray();
if (item0.getValue() != null) {
for (RuntimeField item1 : item0.getValue()) {
item1.serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
if (this.source != null) {
generator.writeKey("_source");
this.source.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeAnalyticsSource}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private List index;
@Nullable
private Query query;
@Nullable
private Map> runtimeMappings;
@Nullable
private DataframeAnalysisAnalyzedFields source;
/**
* Required - Index or indices on which to perform the analysis. It can be a
* single index or index pattern as well as an array of indices or patterns.
* NOTE: If your source indices contain documents with the same IDs, only the
* document that is indexed last appears in the destination index.
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* Required - Index or indices on which to perform the analysis. It can be a
* single index or index pattern as well as an array of indices or patterns.
* NOTE: If your source indices contain documents with the same IDs, only the
* document that is indexed last appears in the destination index.
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. By default, this property has the following
* value: {"match_all": {}}.
*
* API name: {@code query}
*/
public final Builder query(@Nullable Query value) {
this.query = value;
return this;
}
/**
* The Elasticsearch query domain-specific language (DSL). This value
* corresponds to the query object in an Elasticsearch search POST body. All the
* options that are supported by Elasticsearch can be used, as this object is
* passed verbatim to Elasticsearch. By default, this property has the following
* value: {"match_all": {}}.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new Query.Builder()).build());
}
/**
* Definitions of runtime fields that will become part of the mapping of the
* destination index.
*
* API name: {@code runtime_mappings}
*
* Adds all entries of map to runtimeMappings.
*/
public final Builder runtimeMappings(Map> map) {
this.runtimeMappings = _mapPutAll(this.runtimeMappings, map);
return this;
}
/**
* Definitions of runtime fields that will become part of the mapping of the
* destination index.
*
* API name: {@code runtime_mappings}
*
* Adds an entry to runtimeMappings.
*/
public final Builder runtimeMappings(String key, List value) {
this.runtimeMappings = _mapPut(this.runtimeMappings, key, value);
return this;
}
/**
* Specify includes and/or `excludes patterns to select which
* fields will be present in the destination. Fields that are excluded cannot be
* included in the analysis.
*
* API name: {@code _source}
*/
public final Builder source(@Nullable DataframeAnalysisAnalyzedFields value) {
this.source = value;
return this;
}
/**
* Specify includes and/or `excludes patterns to select which
* fields will be present in the destination. Fields that are excluded cannot be
* included in the analysis.
*
* API name: {@code _source}
*/
public final Builder source(
Function> fn) {
return this.source(fn.apply(new DataframeAnalysisAnalyzedFields.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeAnalyticsSource}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeAnalyticsSource build() {
_checkSingleUse();
return new DataframeAnalyticsSource(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeAnalyticsSource}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataframeAnalyticsSource::setupDataframeAnalyticsSourceDeserializer);
protected static void setupDataframeAnalyticsSourceDeserializer(
ObjectDeserializer op) {
op.add(Builder::index, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "index");
op.add(Builder::query, Query._DESERIALIZER, "query");
op.add(Builder::runtimeMappings, JsonpDeserializer.stringMapDeserializer(
JsonpDeserializer.arrayDeserializer(RuntimeField._DESERIALIZER)), "runtime_mappings");
op.add(Builder::source, DataframeAnalysisAnalyzedFields._DESERIALIZER, "_source");
}
}