Package co.elastic.clients.elasticsearch.ingest

Class UserAgentProcessor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>

co.elastic.clients.elasticsearch.ingest.UserAgentProcessor.Builder

All Implemented Interfaces:

WithJson<UserAgentProcessor.Builder>, ObjectBuilder<UserAgentProcessor>

Enclosing class:

UserAgentProcessor

public static class UserAgentProcessor.Builder
extends ProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>
implements ObjectBuilder<UserAgentProcessor>

Builder for UserAgentProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserAgentProcessor	build()	Builds a UserAgentProcessor.
final UserAgentProcessor.Builder	extractDeviceType(Boolean value)	Extracts device type from the user agent string on a best-effort basis.
final UserAgentProcessor.Builder	field(String value)	Required - The field containing the user agent string.
final UserAgentProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final UserAgentProcessor.Builder	properties(UserAgentProperty value, UserAgentProperty... values)	Controls what properties are added to target_field.
final UserAgentProcessor.Builder	properties(List<UserAgentProperty> list)	Controls what properties are added to target_field.
final UserAgentProcessor.Builder	regexFile(String value)	The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string.
protected UserAgentProcessor.Builder	self()
final UserAgentProcessor.Builder	targetField(String value)	The field that will be filled with the user agent details.

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder

description, if_, ignoreFailure, onFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final UserAgentProcessor.Builder field(String value)

Required - The field containing the user agent string.

API name: field

ignoreMissing

public final UserAgentProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

API name: ignore_missing

regexFile

public final UserAgentProcessor.Builder regexFile(@Nullable
 String value)

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

public final UserAgentProcessor.Builder targetField(@Nullable
 String value)

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

API name: target_field

properties

public final UserAgentProcessor.Builder properties(List<UserAgentProperty> list)

Controls what properties are added to target_field.

API name: properties

Adds all elements of list to properties.

properties

public final UserAgentProcessor.Builder properties(UserAgentProperty value,
 UserAgentProperty... values)

Controls what properties are added to target_field.

API name: properties

Adds one or more values to properties.

extractDeviceType

public final UserAgentProcessor.Builder extractDeviceType(@Nullable
 Boolean value)

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

API name: extract_device_type

self

protected UserAgentProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>

build

public UserAgentProcessor build()

Builds a UserAgentProcessor.

Specified by:

build in interface ObjectBuilder<UserAgentProcessor>

Throws:

NullPointerException - if some of the required fields are null.