Package org.opensearch.client.opensearch.ingest

Class UserAgentProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>

org.opensearch.client.opensearch.ingest.UserAgentProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>, MutableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>, ObjectBuilder<UserAgentProcessor>

Enclosing class:

UserAgentProcessor

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

Builder for UserAgentProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserAgentProcessor	build()	Builds a UserAgentProcessor.
UserAgentProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final UserAgentProcessor.Builder	field(String value)	Required - API name: field
final UserAgentProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final UserAgentProcessor.Builder	options(List<UserAgentProperty> list)	API name: options
final UserAgentProcessor.Builder	options(UserAgentProperty value, UserAgentProperty... values)	API name: options
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)	API name: target_field

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

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public UserAgentProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<UserAgentProcessor.Builder,UserAgentProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected UserAgentProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<UserAgentProcessor.Builder>

field

@Nonnull
public final UserAgentProcessor.Builder field(String value)

Required - API name: field

ignoreMissing

@Nonnull
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

options

@Nonnull
public final UserAgentProcessor.Builder options(List<UserAgentProperty> list)

API name: options

Adds all elements of list to options.

options

@Nonnull
public final UserAgentProcessor.Builder options(UserAgentProperty value,
 UserAgentProperty... values)

API name: options

Adds one or more values to options.

regexFile

@Nonnull
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 OpenSearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.

API name: regex_file

targetField

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

API name: target_field

build

@Nonnull
public UserAgentProcessor build()

Builds a UserAgentProcessor.

Specified by:

build in interface ObjectBuilder<UserAgentProcessor>

Throws:

NullPointerException - if some of the required fields are null.