co.elastic.clients.elasticsearch.ml.DataframeAnalysisFeatureProcessorNGramEncoding Maven / Gradle / Ivy
/*
* 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.ml;
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.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
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: ml._types.DataframeAnalysisFeatureProcessorNGramEncoding
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeAnalysisFeatureProcessorNGramEncoding
implements
DataframeAnalysisFeatureProcessorVariant,
JsonpSerializable {
@Nullable
private final String featurePrefix;
private final String field;
@Nullable
private final Integer length;
private final List nGrams;
@Nullable
private final Integer start;
@Nullable
private final Boolean custom;
// ---------------------------------------------------------------------------------------------
private DataframeAnalysisFeatureProcessorNGramEncoding(Builder builder) {
this.featurePrefix = builder.featurePrefix;
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.length = builder.length;
this.nGrams = ApiTypeHelper.unmodifiableRequired(builder.nGrams, this, "nGrams");
this.start = builder.start;
this.custom = builder.custom;
}
public static DataframeAnalysisFeatureProcessorNGramEncoding of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* DataframeAnalysisFeatureProcessor variant kind.
*/
@Override
public DataframeAnalysisFeatureProcessor.Kind _dataframeAnalysisFeatureProcessorKind() {
return DataframeAnalysisFeatureProcessor.Kind.NGramEncoding;
}
/**
* The feature name prefix. Defaults to ngram_<start>_<length>.
*
* API name: {@code feature_prefix}
*/
@Nullable
public final String featurePrefix() {
return this.featurePrefix;
}
/**
* Required - The name of the text field to encode.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* Specifies the length of the n-gram substring. Defaults to 50. Must be greater
* than 0.
*
* API name: {@code length}
*/
@Nullable
public final Integer length() {
return this.length;
}
/**
* Required - Specifies which n-grams to gather. It’s an array of integer values
* where the minimum value is 1, and a maximum value is 5.
*
* API name: {@code n_grams}
*/
public final List nGrams() {
return this.nGrams;
}
/**
* Specifies the zero-indexed start of the n-gram substring. Negative values are
* allowed for encoding n-grams of string suffixes. Defaults to 0.
*
* API name: {@code start}
*/
@Nullable
public final Integer start() {
return this.start;
}
/**
* API name: {@code custom}
*/
@Nullable
public final Boolean custom() {
return this.custom;
}
/**
* 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.featurePrefix != null) {
generator.writeKey("feature_prefix");
generator.write(this.featurePrefix);
}
generator.writeKey("field");
generator.write(this.field);
if (this.length != null) {
generator.writeKey("length");
generator.write(this.length);
}
if (ApiTypeHelper.isDefined(this.nGrams)) {
generator.writeKey("n_grams");
generator.writeStartArray();
for (Integer item0 : this.nGrams) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.start != null) {
generator.writeKey("start");
generator.write(this.start);
}
if (this.custom != null) {
generator.writeKey("custom");
generator.write(this.custom);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeAnalysisFeatureProcessorNGramEncoding}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private String featurePrefix;
private String field;
@Nullable
private Integer length;
private List nGrams;
@Nullable
private Integer start;
@Nullable
private Boolean custom;
/**
* The feature name prefix. Defaults to ngram_<start>_<length>.
*
* API name: {@code feature_prefix}
*/
public final Builder featurePrefix(@Nullable String value) {
this.featurePrefix = value;
return this;
}
/**
* Required - The name of the text field to encode.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* Specifies the length of the n-gram substring. Defaults to 50. Must be greater
* than 0.
*
* API name: {@code length}
*/
public final Builder length(@Nullable Integer value) {
this.length = value;
return this;
}
/**
* Required - Specifies which n-grams to gather. It’s an array of integer values
* where the minimum value is 1, and a maximum value is 5.
*
* API name: {@code n_grams}
*
* Adds all elements of list to nGrams.
*/
public final Builder nGrams(List list) {
this.nGrams = _listAddAll(this.nGrams, list);
return this;
}
/**
* Required - Specifies which n-grams to gather. It’s an array of integer values
* where the minimum value is 1, and a maximum value is 5.
*
* API name: {@code n_grams}
*
* Adds one or more values to nGrams.
*/
public final Builder nGrams(Integer value, Integer... values) {
this.nGrams = _listAdd(this.nGrams, value, values);
return this;
}
/**
* Specifies the zero-indexed start of the n-gram substring. Negative values are
* allowed for encoding n-grams of string suffixes. Defaults to 0.
*
* API name: {@code start}
*/
public final Builder start(@Nullable Integer value) {
this.start = value;
return this;
}
/**
* API name: {@code custom}
*/
public final Builder custom(@Nullable Boolean value) {
this.custom = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeAnalysisFeatureProcessorNGramEncoding}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeAnalysisFeatureProcessorNGramEncoding build() {
_checkSingleUse();
return new DataframeAnalysisFeatureProcessorNGramEncoding(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeAnalysisFeatureProcessorNGramEncoding}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new,
DataframeAnalysisFeatureProcessorNGramEncoding::setupDataframeAnalysisFeatureProcessorNGramEncodingDeserializer);
protected static void setupDataframeAnalysisFeatureProcessorNGramEncodingDeserializer(
ObjectDeserializer op) {
op.add(Builder::featurePrefix, JsonpDeserializer.stringDeserializer(), "feature_prefix");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::length, JsonpDeserializer.integerDeserializer(), "length");
op.add(Builder::nGrams, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.integerDeserializer()),
"n_grams");
op.add(Builder::start, JsonpDeserializer.integerDeserializer(), "start");
op.add(Builder::custom, JsonpDeserializer.booleanDeserializer(), "custom");
}
}