co.elastic.clients.elasticsearch.synonyms.SynonymRule 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.synonyms;
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.String;
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: synonyms._types.SynonymRule
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class SynonymRule implements JsonpSerializable {
@Nullable
private final String id;
private final String synonyms;
// ---------------------------------------------------------------------------------------------
private SynonymRule(Builder builder) {
this.id = builder.id;
this.synonyms = ApiTypeHelper.requireNonNull(builder.synonyms, this, "synonyms");
}
public static SynonymRule of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Synonym Rule identifier
*
* API name: {@code id}
*/
@Nullable
public final String id() {
return this.id;
}
/**
* Required - Synonyms, in Solr format, that conform the synonym rule. See
* https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2
*
* API name: {@code synonyms}
*/
public final String synonyms() {
return this.synonyms;
}
/**
* 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.id != null) {
generator.writeKey("id");
generator.write(this.id);
}
generator.writeKey("synonyms");
generator.write(this.synonyms);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link SynonymRule}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String id;
private String synonyms;
/**
* Synonym Rule identifier
*
* API name: {@code id}
*/
public final Builder id(@Nullable String value) {
this.id = value;
return this;
}
/**
* Required - Synonyms, in Solr format, that conform the synonym rule. See
* https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2
*
* API name: {@code synonyms}
*/
public final Builder synonyms(String value) {
this.synonyms = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link SynonymRule}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public SynonymRule build() {
_checkSingleUse();
return new SynonymRule(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link SynonymRule}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
SynonymRule::setupSynonymRuleDeserializer);
protected static void setupSynonymRuleDeserializer(ObjectDeserializer op) {
op.add(Builder::id, JsonpDeserializer.stringDeserializer(), "id");
op.add(Builder::synonyms, JsonpDeserializer.stringDeserializer(), "synonyms");
}
}