Package org.opensearch.client.opensearch.ingest

Class UserAgentProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.UserAgentProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class UserAgentProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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.
static UserAgentProcessor.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - API name: field
int	hashCode()
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>	options()	API name: options
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()	API name: target_field
UserAgentProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final String field()

Required - 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

options

@Nonnull
public final List<UserAgentProperty> options()

API name: options

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 OpenSearch. 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()

API name: target_field

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public UserAgentProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static UserAgentProcessor.Builder builder()

setupUserAgentProcessorDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase