Package co.elastic.clients.elasticsearch.ingest

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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserAgentProcessor.Builder	Builder for UserAgentProcessor.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<UserAgentProcessor>	_DESERIALIZER	Json deserializer for UserAgentProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final Boolean	extractDeviceType()	Extracts device type from the user agent string on a best-effort basis.
final String	field()	Required - The field containing the user agent string.
final Boolean	ignoreMissing()	If true and field does not exist, the processor quietly exits without modifying the document.
static UserAgentProcessor	of(Function<UserAgentProcessor.Builder,ObjectBuilder<UserAgentProcessor>> fn)
final List<UserAgentProperty>	properties()	Controls what properties are added to target_field.
final String	regexFile()	The name of the file in the config/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	setupUserAgentProcessorDeserializer(ObjectDeserializer<UserAgentProcessor.Builder> op)
final String	targetField()	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

public static final JsonpDeserializer<UserAgentProcessor> _DESERIALIZER

Json deserializer for UserAgentProcessor

Method Details

of

public static UserAgentProcessor of(Function<UserAgentProcessor.Builder,ObjectBuilder<UserAgentProcessor>> fn)

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

field

public final String field()

Required - The field containing the user agent string.

API name: field

ignoreMissing

@Nullable
public final Boolean ignoreMissing()

If true and field does not exist, the processor quietly exits without modifying the document.

API name: ignore_missing

regexFile

@Nullable
public final String regexFile()

The name of the file in the config/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 the regexes.yaml from uap-core it ships with.

API name: regex_file

targetField

@Nullable
public final String targetField()

The field that will be filled with the user agent details.

API name: target_field

properties

public final List<UserAgentProperty> properties()

Controls what properties are added to target_field.

API name: properties

extractDeviceType

@Nullable
public final Boolean extractDeviceType()

Extracts device type from the user agent string on a best-effort basis.

API name: extract_device_type

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class ProcessorBase

setupUserAgentProcessorDeserializer

protected static void setupUserAgentProcessorDeserializer(ObjectDeserializer<UserAgentProcessor.Builder> op)