Package org.opensearch.client.opensearch.ingest

Class GeoIpProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.GeoIpProcessor

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<GeoIpProcessor>	_DESERIALIZER	Json deserializer for GeoIpProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
static GeoIpProcessor.Builder	builder()
final String	databaseFile()	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.
boolean	equals(Object o)
final String	field()	Required - API name: field
final Boolean	firstOnly()	If true, only the first found geoip data will be returned, even if the field contains an array.
int	hashCode()
final Boolean	ignoreMissing()	If true and field does not exist, the processor quietly exits without modifying the document.
static GeoIpProcessor	of(Function<GeoIpProcessor.Builder,ObjectBuilder<GeoIpProcessor>> fn)
final List<String>	properties()	Controls what properties are added to the target_field based on the geoip lookup.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoIpProcessorDeserializer(ObjectDeserializer<GeoIpProcessor.Builder> op)
final String	targetField()	API name: target_field
GeoIpProcessor.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<GeoIpProcessor> _DESERIALIZER

Json deserializer for GeoIpProcessor

Method Details

of

public static GeoIpProcessor of(Function<GeoIpProcessor.Builder,ObjectBuilder<GeoIpProcessor>> fn)

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

databaseFile

@Nullable
public final String databaseFile()

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 String field()

Required - API name: field

firstOnly

@Nullable
public final Boolean firstOnly()

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

API name: first_only

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

properties

@Nonnull
public final List<String> properties()

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

API name: properties

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 GeoIpProcessor.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<GeoIpProcessor.Builder,GeoIpProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static GeoIpProcessor.Builder builder()

setupGeoIpProcessorDeserializer

protected static void setupGeoIpProcessorDeserializer(ObjectDeserializer<GeoIpProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase