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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aUserAgentProcessor
.Required - The field containing the user agent string.ignoreMissing
(Boolean value) Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.options
(UserAgentProperty value, UserAgentProperty... values) API name:options
options
(List<UserAgentProperty> list) API name:options
The name of the file in theconfig/ingest-user-agent
directory containing the regular expressions for parsing the user agent string.protected UserAgentProcessor.Builder
self()
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, 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
tooptions
. -
options
public final UserAgentProcessor.Builder options(UserAgentProperty value, UserAgentProperty... values) API name:options
Adds one or more values to
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
-
self
- Specified by:
self
in classProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>
-
build
Builds aUserAgentProcessor
.- Specified by:
build
in interfaceObjectBuilder<UserAgentProcessor>
- Throws:
NullPointerException
- if some of the required fields are null.
-