co.elastic.clients.elasticsearch.ingest.KeyValueProcessor 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.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.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: ingest._types.KeyValueProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class KeyValueProcessor extends ProcessorBase implements ProcessorVariant {
private final List excludeKeys;
private final String field;
private final String fieldSplit;
@Nullable
private final Boolean ignoreMissing;
private final List includeKeys;
@Nullable
private final String prefix;
@Nullable
private final Boolean stripBrackets;
@Nullable
private final String targetField;
@Nullable
private final String trimKey;
@Nullable
private final String trimValue;
private final String valueSplit;
// ---------------------------------------------------------------------------------------------
private KeyValueProcessor(Builder builder) {
super(builder);
this.excludeKeys = ApiTypeHelper.unmodifiable(builder.excludeKeys);
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.fieldSplit = ApiTypeHelper.requireNonNull(builder.fieldSplit, this, "fieldSplit");
this.ignoreMissing = builder.ignoreMissing;
this.includeKeys = ApiTypeHelper.unmodifiable(builder.includeKeys);
this.prefix = builder.prefix;
this.stripBrackets = builder.stripBrackets;
this.targetField = builder.targetField;
this.trimKey = builder.trimKey;
this.trimValue = builder.trimValue;
this.valueSplit = ApiTypeHelper.requireNonNull(builder.valueSplit, this, "valueSplit");
}
public static KeyValueProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.Kv;
}
/**
* List of keys to exclude from document.
*
* API name: {@code exclude_keys}
*/
public final List excludeKeys() {
return this.excludeKeys;
}
/**
* Required - The field to be parsed. Supports template snippets.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* Required - Regex pattern to use for splitting key-value pairs.
*
* API name: {@code field_split}
*/
public final String fieldSplit() {
return this.fieldSplit;
}
/**
* If true and field does not exist or is
* null, the processor quietly exits without modifying the
* document.
*
* API name: {@code ignore_missing}
*/
@Nullable
public final Boolean ignoreMissing() {
return this.ignoreMissing;
}
/**
* List of keys to filter and insert into document. Defaults to including all
* keys.
*
* API name: {@code include_keys}
*/
public final List includeKeys() {
return this.includeKeys;
}
/**
* Prefix to be added to extracted keys.
*
* API name: {@code prefix}
*/
@Nullable
public final String prefix() {
return this.prefix;
}
/**
* If true. strip brackets (), <>,
* [] as well as quotes ' and " from
* extracted values.
*
* API name: {@code strip_brackets}
*/
@Nullable
public final Boolean stripBrackets() {
return this.stripBrackets;
}
/**
* The field to insert the extracted keys into. Defaults to the root of the
* document. Supports template snippets.
*
* API name: {@code target_field}
*/
@Nullable
public final String targetField() {
return this.targetField;
}
/**
* String of characters to trim from extracted keys.
*
* API name: {@code trim_key}
*/
@Nullable
public final String trimKey() {
return this.trimKey;
}
/**
* String of characters to trim from extracted values.
*
* API name: {@code trim_value}
*/
@Nullable
public final String trimValue() {
return this.trimValue;
}
/**
* Required - Regex pattern to use for splitting the key from the value within a
* key-value pair.
*
* API name: {@code value_split}
*/
public final String valueSplit() {
return this.valueSplit;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
if (ApiTypeHelper.isDefined(this.excludeKeys)) {
generator.writeKey("exclude_keys");
generator.writeStartArray();
for (String item0 : this.excludeKeys) {
generator.write(item0);
}
generator.writeEnd();
}
generator.writeKey("field");
generator.write(this.field);
generator.writeKey("field_split");
generator.write(this.fieldSplit);
if (this.ignoreMissing != null) {
generator.writeKey("ignore_missing");
generator.write(this.ignoreMissing);
}
if (ApiTypeHelper.isDefined(this.includeKeys)) {
generator.writeKey("include_keys");
generator.writeStartArray();
for (String item0 : this.includeKeys) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.prefix != null) {
generator.writeKey("prefix");
generator.write(this.prefix);
}
if (this.stripBrackets != null) {
generator.writeKey("strip_brackets");
generator.write(this.stripBrackets);
}
if (this.targetField != null) {
generator.writeKey("target_field");
generator.write(this.targetField);
}
if (this.trimKey != null) {
generator.writeKey("trim_key");
generator.write(this.trimKey);
}
if (this.trimValue != null) {
generator.writeKey("trim_value");
generator.write(this.trimValue);
}
generator.writeKey("value_split");
generator.write(this.valueSplit);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link KeyValueProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private List excludeKeys;
private String field;
private String fieldSplit;
@Nullable
private Boolean ignoreMissing;
@Nullable
private List includeKeys;
@Nullable
private String prefix;
@Nullable
private Boolean stripBrackets;
@Nullable
private String targetField;
@Nullable
private String trimKey;
@Nullable
private String trimValue;
private String valueSplit;
/**
* List of keys to exclude from document.
*
* API name: {@code exclude_keys}
*
* Adds all elements of list to excludeKeys.
*/
public final Builder excludeKeys(List list) {
this.excludeKeys = _listAddAll(this.excludeKeys, list);
return this;
}
/**
* List of keys to exclude from document.
*
* API name: {@code exclude_keys}
*
* Adds one or more values to excludeKeys.
*/
public final Builder excludeKeys(String value, String... values) {
this.excludeKeys = _listAdd(this.excludeKeys, value, values);
return this;
}
/**
* Required - The field to be parsed. Supports template snippets.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* Required - Regex pattern to use for splitting key-value pairs.
*
* API name: {@code field_split}
*/
public final Builder fieldSplit(String value) {
this.fieldSplit = value;
return this;
}
/**
* If true and field does not exist or is
* null, 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;
}
/**
* List of keys to filter and insert into document. Defaults to including all
* keys.
*
* API name: {@code include_keys}
*
* Adds all elements of list to includeKeys.
*/
public final Builder includeKeys(List list) {
this.includeKeys = _listAddAll(this.includeKeys, list);
return this;
}
/**
* List of keys to filter and insert into document. Defaults to including all
* keys.
*
* API name: {@code include_keys}
*
* Adds one or more values to includeKeys.
*/
public final Builder includeKeys(String value, String... values) {
this.includeKeys = _listAdd(this.includeKeys, value, values);
return this;
}
/**
* Prefix to be added to extracted keys.
*
* API name: {@code prefix}
*/
public final Builder prefix(@Nullable String value) {
this.prefix = value;
return this;
}
/**
* If true. strip brackets (), <>,
* [] as well as quotes ' and " from
* extracted values.
*
* API name: {@code strip_brackets}
*/
public final Builder stripBrackets(@Nullable Boolean value) {
this.stripBrackets = value;
return this;
}
/**
* The field to insert the extracted keys into. Defaults to the root of the
* document. Supports template snippets.
*
* API name: {@code target_field}
*/
public final Builder targetField(@Nullable String value) {
this.targetField = value;
return this;
}
/**
* String of characters to trim from extracted keys.
*
* API name: {@code trim_key}
*/
public final Builder trimKey(@Nullable String value) {
this.trimKey = value;
return this;
}
/**
* String of characters to trim from extracted values.
*
* API name: {@code trim_value}
*/
public final Builder trimValue(@Nullable String value) {
this.trimValue = value;
return this;
}
/**
* Required - Regex pattern to use for splitting the key from the value within a
* key-value pair.
*
* API name: {@code value_split}
*/
public final Builder valueSplit(String value) {
this.valueSplit = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link KeyValueProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public KeyValueProcessor build() {
_checkSingleUse();
return new KeyValueProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link KeyValueProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, KeyValueProcessor::setupKeyValueProcessorDeserializer);
protected static void setupKeyValueProcessorDeserializer(ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::excludeKeys, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"exclude_keys");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::fieldSplit, JsonpDeserializer.stringDeserializer(), "field_split");
op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing");
op.add(Builder::includeKeys, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"include_keys");
op.add(Builder::prefix, JsonpDeserializer.stringDeserializer(), "prefix");
op.add(Builder::stripBrackets, JsonpDeserializer.booleanDeserializer(), "strip_brackets");
op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field");
op.add(Builder::trimKey, JsonpDeserializer.stringDeserializer(), "trim_key");
op.add(Builder::trimValue, JsonpDeserializer.stringDeserializer(), "trim_value");
op.add(Builder::valueSplit, JsonpDeserializer.stringDeserializer(), "value_split");
}
}