Class GeoIpProcessorDescriptor<T>

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
DescriptorBase<GeoIpProcessorDescriptor<T>, IGeoIpProcessor>
ProcessorDescriptorBase<GeoIpProcessorDescriptor<T>, IGeoIpProcessor>
GeoIpProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GeoIpProcessorDescriptor<T> : ProcessorDescriptorBase<GeoIpProcessorDescriptor<T>, IGeoIpProcessor>, IDescriptor, IGeoIpProcessor, IProcessor where T : class
Type Parameters
Name Description
T
Remarks

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

Properties

| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

DatabaseFile(string)

Declaration
public GeoIpProcessorDescriptor<T> DatabaseFile(string file)
Parameters
Type Name Description
string file
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

Field(Field)

Declaration
public GeoIpProcessorDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

Declaration
public GeoIpProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
GeoIpProcessorDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

FirstOnly(bool?)

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

Declaration
public GeoIpProcessorDescriptor<T> FirstOnly(bool? firstOnly = true)
Parameters
Type Name Description
bool? firstOnly
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

IgnoreMissing(bool?)

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

Declaration
public GeoIpProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
Parameters
Type Name Description
bool? ignoreMissing
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

Properties(IEnumerable<string>)

Declaration
public GeoIpProcessorDescriptor<T> Properties(IEnumerable<string> properties)
Parameters
Type Name Description
IEnumerable<string> properties
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

Properties(params string[])

Declaration
public GeoIpProcessorDescriptor<T> Properties(params string[] properties)
Parameters
Type Name Description
string[] properties
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

Declaration
public GeoIpProcessorDescriptor<T> TargetField(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
GeoIpProcessorDescriptor<T>
| Edit this page View Source

TargetField<TValue>(Expression<Func<T, TValue>>)

Declaration
public GeoIpProcessorDescriptor<T> TargetField<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
GeoIpProcessorDescriptor<T>
Type Parameters
Name Description
TValue

Implements

Extension Methods