Class GeoIpProcessor

The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the geoip field. The geoip processor can resolve both IPv4 and IPv6 addresses.

Inheritance
object
ProcessorBase
GeoIpProcessor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GeoIpProcessor : ProcessorBase, IGeoIpProcessor, IProcessor
Remarks

Requires the Ingest Geoip Processor Plugin to be installed on the cluster.

Properties

| Edit this page View Source

DatabaseFile

Declaration
public string DatabaseFile { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Field

Declaration
public Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

FirstOnly

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

Declaration
public bool? FirstOnly { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreMissing

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

Declaration
public bool? IgnoreMissing { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Properties

Declaration
public IEnumerable<string> Properties { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

TargetField

Declaration
public Field TargetField { get; set; }
Property Value
Type Description
Field

Implements

Extension Methods