co.elastic.clients.elasticsearch.ingest.EnrichProcessor 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.ingest;
import co.elastic.clients.elasticsearch._types.GeoShapeRelation;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
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 jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
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: ingest._types.EnrichProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class EnrichProcessor extends ProcessorBase implements ProcessorVariant {
private final String field;
@Nullable
private final Boolean ignoreMissing;
@Nullable
private final Integer maxMatches;
@Nullable
private final Boolean override;
private final String policyName;
@Nullable
private final GeoShapeRelation shapeRelation;
private final String targetField;
// ---------------------------------------------------------------------------------------------
private EnrichProcessor(Builder builder) {
super(builder);
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.ignoreMissing = builder.ignoreMissing;
this.maxMatches = builder.maxMatches;
this.override = builder.override;
this.policyName = ApiTypeHelper.requireNonNull(builder.policyName, this, "policyName");
this.shapeRelation = builder.shapeRelation;
this.targetField = ApiTypeHelper.requireNonNull(builder.targetField, this, "targetField");
}
public static EnrichProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.Enrich;
}
/**
* Required - The field in the input document that matches the policies
* match_field used to retrieve the enrichment data. Supports template snippets.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* If true and field does not exist, the processor
* quietly exits without modifying the document.
*
* API name: {@code ignore_missing}
*/
@Nullable
public final Boolean ignoreMissing() {
return this.ignoreMissing;
}
/**
* The maximum number of matched documents to include under the configured
* target field. The target_field will be turned into a json array
* if max_matches is higher than 1, otherwise
* target_field will become a json object. In order to avoid
* documents getting too large, the maximum allowed value is 128.
*
* API name: {@code max_matches}
*/
@Nullable
public final Integer maxMatches() {
return this.maxMatches;
}
/**
* If processor will update fields with pre-existing non-null-valued field. When
* set to false, such fields will not be touched.
*
* API name: {@code override}
*/
@Nullable
public final Boolean override() {
return this.override;
}
/**
* Required - The name of the enrich policy to use.
*
* API name: {@code policy_name}
*/
public final String policyName() {
return this.policyName;
}
/**
* A spatial relation operator used to match the geoshape of incoming documents
* to documents in the enrich index. This option is only used for
* geo_match enrich policy types.
*
* API name: {@code shape_relation}
*/
@Nullable
public final GeoShapeRelation shapeRelation() {
return this.shapeRelation;
}
/**
* Required - Field added to incoming documents to contain enrich data. This
* field contains both the match_field and
* enrich_fields specified in the enrich policy. Supports template
* snippets.
*
* API name: {@code target_field}
*/
public final String targetField() {
return this.targetField;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
generator.writeKey("field");
generator.write(this.field);
if (this.ignoreMissing != null) {
generator.writeKey("ignore_missing");
generator.write(this.ignoreMissing);
}
if (this.maxMatches != null) {
generator.writeKey("max_matches");
generator.write(this.maxMatches);
}
if (this.override != null) {
generator.writeKey("override");
generator.write(this.override);
}
generator.writeKey("policy_name");
generator.write(this.policyName);
if (this.shapeRelation != null) {
generator.writeKey("shape_relation");
this.shapeRelation.serialize(generator, mapper);
}
generator.writeKey("target_field");
generator.write(this.targetField);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link EnrichProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder
implements
ObjectBuilder {
private String field;
@Nullable
private Boolean ignoreMissing;
@Nullable
private Integer maxMatches;
@Nullable
private Boolean override;
private String policyName;
@Nullable
private GeoShapeRelation shapeRelation;
private String targetField;
/**
* Required - The field in the input document that matches the policies
* match_field used to retrieve the enrichment data. Supports template snippets.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* If true and field does not exist, the processor
* quietly exits without modifying the document.
*
* API name: {@code ignore_missing}
*/
public final Builder ignoreMissing(@Nullable Boolean value) {
this.ignoreMissing = value;
return this;
}
/**
* The maximum number of matched documents to include under the configured
* target field. The target_field will be turned into a json array
* if max_matches is higher than 1, otherwise
* target_field will become a json object. In order to avoid
* documents getting too large, the maximum allowed value is 128.
*
* API name: {@code max_matches}
*/
public final Builder maxMatches(@Nullable Integer value) {
this.maxMatches = value;
return this;
}
/**
* If processor will update fields with pre-existing non-null-valued field. When
* set to false, such fields will not be touched.
*
* API name: {@code override}
*/
public final Builder override(@Nullable Boolean value) {
this.override = value;
return this;
}
/**
* Required - The name of the enrich policy to use.
*
* API name: {@code policy_name}
*/
public final Builder policyName(String value) {
this.policyName = value;
return this;
}
/**
* A spatial relation operator used to match the geoshape of incoming documents
* to documents in the enrich index. This option is only used for
* geo_match enrich policy types.
*
* API name: {@code shape_relation}
*/
public final Builder shapeRelation(@Nullable GeoShapeRelation value) {
this.shapeRelation = value;
return this;
}
/**
* Required - Field added to incoming documents to contain enrich data. This
* field contains both the match_field and
* enrich_fields specified in the enrich policy. Supports template
* snippets.
*
* API name: {@code target_field}
*/
public final Builder targetField(String value) {
this.targetField = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link EnrichProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public EnrichProcessor build() {
_checkSingleUse();
return new EnrichProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link EnrichProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
EnrichProcessor::setupEnrichProcessorDeserializer);
protected static void setupEnrichProcessorDeserializer(ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing");
op.add(Builder::maxMatches, JsonpDeserializer.integerDeserializer(), "max_matches");
op.add(Builder::override, JsonpDeserializer.booleanDeserializer(), "override");
op.add(Builder::policyName, JsonpDeserializer.stringDeserializer(), "policy_name");
op.add(Builder::shapeRelation, GeoShapeRelation._DESERIALIZER, "shape_relation");
op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field");
}
}