co.elastic.clients.elasticsearch.ingest.GrokProcessor 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.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.Map;
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.GrokProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class GrokProcessor extends ProcessorBase implements ProcessorVariant {
@Nullable
private final String ecsCompatibility;
private final String field;
@Nullable
private final Boolean ignoreMissing;
private final Map patternDefinitions;
private final List patterns;
@Nullable
private final Boolean traceMatch;
// ---------------------------------------------------------------------------------------------
private GrokProcessor(Builder builder) {
super(builder);
this.ecsCompatibility = builder.ecsCompatibility;
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.ignoreMissing = builder.ignoreMissing;
this.patternDefinitions = ApiTypeHelper.unmodifiable(builder.patternDefinitions);
this.patterns = ApiTypeHelper.unmodifiableRequired(builder.patterns, this, "patterns");
this.traceMatch = builder.traceMatch;
}
public static GrokProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.Grok;
}
/**
* Must be disabled or v1. If v1, the processor uses patterns with Elastic
* Common Schema (ECS) field names.
*
* API name: {@code ecs_compatibility}
*/
@Nullable
public final String ecsCompatibility() {
return this.ecsCompatibility;
}
/**
* Required - The field to use for grok expression parsing.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* 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;
}
/**
* A map of pattern-name and pattern tuples defining custom patterns to be used
* by the current processor. Patterns matching existing names will override the
* pre-existing definition.
*
* API name: {@code pattern_definitions}
*/
public final Map patternDefinitions() {
return this.patternDefinitions;
}
/**
* Required - An ordered list of grok expression to match and extract named
* captures with. Returns on the first expression in the list that matches.
*
* API name: {@code patterns}
*/
public final List patterns() {
return this.patterns;
}
/**
* When true, _ingest._grok_match_index will be
* inserted into your matched document’s metadata with the index into the
* pattern found in patterns that matched.
*
* API name: {@code trace_match}
*/
@Nullable
public final Boolean traceMatch() {
return this.traceMatch;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
if (this.ecsCompatibility != null) {
generator.writeKey("ecs_compatibility");
generator.write(this.ecsCompatibility);
}
generator.writeKey("field");
generator.write(this.field);
if (this.ignoreMissing != null) {
generator.writeKey("ignore_missing");
generator.write(this.ignoreMissing);
}
if (ApiTypeHelper.isDefined(this.patternDefinitions)) {
generator.writeKey("pattern_definitions");
generator.writeStartObject();
for (Map.Entry item0 : this.patternDefinitions.entrySet()) {
generator.writeKey(item0.getKey());
generator.write(item0.getValue());
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.patterns)) {
generator.writeKey("patterns");
generator.writeStartArray();
for (String item0 : this.patterns) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.traceMatch != null) {
generator.writeKey("trace_match");
generator.write(this.traceMatch);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GrokProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private String ecsCompatibility;
private String field;
@Nullable
private Boolean ignoreMissing;
@Nullable
private Map patternDefinitions;
private List patterns;
@Nullable
private Boolean traceMatch;
/**
* Must be disabled or v1. If v1, the processor uses patterns with Elastic
* Common Schema (ECS) field names.
*
* API name: {@code ecs_compatibility}
*/
public final Builder ecsCompatibility(@Nullable String value) {
this.ecsCompatibility = value;
return this;
}
/**
* Required - The field to use for grok expression parsing.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = 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;
}
/**
* A map of pattern-name and pattern tuples defining custom patterns to be used
* by the current processor. Patterns matching existing names will override the
* pre-existing definition.
*
* API name: {@code pattern_definitions}
*
* Adds all entries of map to patternDefinitions.
*/
public final Builder patternDefinitions(Map map) {
this.patternDefinitions = _mapPutAll(this.patternDefinitions, map);
return this;
}
/**
* A map of pattern-name and pattern tuples defining custom patterns to be used
* by the current processor. Patterns matching existing names will override the
* pre-existing definition.
*
* API name: {@code pattern_definitions}
*
* Adds an entry to patternDefinitions.
*/
public final Builder patternDefinitions(String key, String value) {
this.patternDefinitions = _mapPut(this.patternDefinitions, key, value);
return this;
}
/**
* Required - An ordered list of grok expression to match and extract named
* captures with. Returns on the first expression in the list that matches.
*
* API name: {@code patterns}
*
* Adds all elements of list to patterns.
*/
public final Builder patterns(List list) {
this.patterns = _listAddAll(this.patterns, list);
return this;
}
/**
* Required - An ordered list of grok expression to match and extract named
* captures with. Returns on the first expression in the list that matches.
*
* API name: {@code patterns}
*
* Adds one or more values to patterns.
*/
public final Builder patterns(String value, String... values) {
this.patterns = _listAdd(this.patterns, value, values);
return this;
}
/**
* When true, _ingest._grok_match_index will be
* inserted into your matched document’s metadata with the index into the
* pattern found in patterns that matched.
*
* API name: {@code trace_match}
*/
public final Builder traceMatch(@Nullable Boolean value) {
this.traceMatch = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GrokProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GrokProcessor build() {
_checkSingleUse();
return new GrokProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link GrokProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
GrokProcessor::setupGrokProcessorDeserializer);
protected static void setupGrokProcessorDeserializer(ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::ecsCompatibility, JsonpDeserializer.stringDeserializer(), "ecs_compatibility");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing");
op.add(Builder::patternDefinitions,
JsonpDeserializer.stringMapDeserializer(JsonpDeserializer.stringDeserializer()), "pattern_definitions");
op.add(Builder::patterns, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"patterns");
op.add(Builder::traceMatch, JsonpDeserializer.booleanDeserializer(), "trace_match");
}
}