Class UserAgentProcessor
java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.UserAgentProcessor
- All Implemented Interfaces:
ProcessorVariant
,JsonpSerializable
@JsonpDeserializable
public class UserAgentProcessor
extends ProcessorBase
implements ProcessorVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<UserAgentProcessor>
Json deserializer forUserAgentProcessor
-
Method Summary
Modifier and TypeMethodDescriptionProcessor variant kind.final String
field()
Required - The field containing the user agent string.final Boolean
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.static UserAgentProcessor
final List<UserAgentProperty>
options()
API name:options
final String
The name of the file in theconfig/ingest-user-agent
directory containing the regular expressions for parsing the user agent string.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
The field that will be filled with the user agent details.Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch.ingest.ProcessorVariant
_toProcessor
-
Field Details
-
_DESERIALIZER
Json deserializer forUserAgentProcessor
-
-
Method Details
-
of
public static UserAgentProcessor of(Function<UserAgentProcessor.Builder, ObjectBuilder<UserAgentProcessor>> fn) -
_processorKind
Processor variant kind.- Specified by:
_processorKind
in interfaceProcessorVariant
-
field
Required - The field containing the user agent string.API name:
field
-
ignoreMissing
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.API name:
ignore_missing
-
options
API name:options
-
regexFile
The name of the file in theconfig/ingest-user-agent
directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use theregexes.yaml
from uap-core it ships with.API name:
regex_file
-
targetField
The field that will be filled with the user agent details.API name:
target_field
-
serializeInternal
- Overrides:
serializeInternal
in classProcessorBase
-
setupUserAgentProcessorDeserializer
protected static void setupUserAgentProcessorDeserializer(ObjectDeserializer<UserAgentProcessor.Builder> op)
-