Package org.opensearch.client.opensearch.ingest

Class GeoIpProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.GeoIpProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

GeoIpProcessor

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

Builder for GeoIpProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoIpProcessor	build()	Builds a GeoIpProcessor.
GeoIpProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoIpProcessor.Builder	databaseFile(String value)	The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
final GeoIpProcessor.Builder	field(String value)	Required - API name: field
final GeoIpProcessor.Builder	firstOnly(Boolean value)	If true, only the first found geoip data will be returned, even if the field contains an array.
final GeoIpProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final GeoIpProcessor.Builder	properties(String value, String... values)	Controls what properties are added to the target_field based on the geoip lookup.
final GeoIpProcessor.Builder	properties(List<String> list)	Controls what properties are added to the target_field based on the geoip lookup.
protected GeoIpProcessor.Builder	self()
final GeoIpProcessor.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 GeoIpProcessor.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<GeoIpProcessor.Builder,GeoIpProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected GeoIpProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<GeoIpProcessor.Builder>

databaseFile

@Nonnull
public final GeoIpProcessor.Builder databaseFile(@Nullable
 String value)

The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.

API name: database_file

field

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

Required - API name: field

firstOnly

@Nonnull
public final GeoIpProcessor.Builder firstOnly(@Nullable
 Boolean value)

If true, only the first found geoip data will be returned, even if the field contains an array.

API name: first_only

ignoreMissing

@Nonnull
public final GeoIpProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

API name: ignore_missing

properties

@Nonnull
public final GeoIpProcessor.Builder properties(List<String> list)

Controls what properties are added to the target_field based on the geoip lookup.

API name: properties

Adds all elements of list to properties.

properties

@Nonnull
public final GeoIpProcessor.Builder properties(String value,
 String... values)

Controls what properties are added to the target_field based on the geoip lookup.

API name: properties

Adds one or more values to properties.

targetField

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

API name: target_field

build

@Nonnull
public GeoIpProcessor build()

Builds a GeoIpProcessor.

Specified by:

build in interface ObjectBuilder<GeoIpProcessor>

Throws:

NullPointerException - if some of the required fields are null.