/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
using System.Runtime.Serialization;
using OpenSearch.Net.Utf8Json;
namespace OpenSearch.Client.Specification.IngestApi
{
///
/// 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.
///
///
/// Requires the Ingest Geoip Processor Plugin to be installed on the cluster.
///
[InterfaceDataContract]
public interface IGeoIpProcessor : IProcessor
{
[DataMember(Name ="database_file")]
string DatabaseFile { get; set; }
[DataMember(Name ="field")]
Field Field { get; set; }
///
/// If `true` and `field` does not exist, the processor quietly exits without modifying the document
///
[DataMember(Name ="ignore_missing")]
bool? IgnoreMissing { get; set; }
[DataMember(Name ="properties")]
IEnumerable Properties { get; set; }
[DataMember(Name ="target_field")]
Field TargetField { get; set; }
///
/// If true, only first found geoip data will be returned, even if field contains array.
/// Defaults to true
///
[DataMember(Name = "first_only")]
bool? FirstOnly { get; set; }
}
///
/// 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.
///
///
/// Requires the Ingest Geoip Processor Plugin to be installed on the cluster.
///
public class GeoIpProcessor : ProcessorBase, IGeoIpProcessor
{
public string DatabaseFile { get; set; }
public Field Field { get; set; }
///
public bool? IgnoreMissing { get; set; }
public IEnumerable Properties { get; set; }
public Field TargetField { get; set; }
///
public bool? FirstOnly { get; set; }
protected override string Name => "geoip";
}
///
/// 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.
///
///
/// Requires the Ingest Geoip Processor Plugin to be installed on the cluster.
///
public class GeoIpProcessorDescriptor
: ProcessorDescriptorBase, IGeoIpProcessor>, IGeoIpProcessor
where T : class
{
protected override string Name => "geoip";
string IGeoIpProcessor.DatabaseFile { get; set; }
Field IGeoIpProcessor.Field { get; set; }
bool? IGeoIpProcessor.IgnoreMissing { get; set; }
IEnumerable IGeoIpProcessor.Properties { get; set; }
Field IGeoIpProcessor.TargetField { get; set; }
bool? IGeoIpProcessor.FirstOnly { get; set; }
public GeoIpProcessorDescriptor Field(Field field) => Assign(field, (a, v) => a.Field = v);
public GeoIpProcessorDescriptor Field(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.Field = v);
///
public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) => Assign(ignoreMissing, (a, v) => a.IgnoreMissing = v);
public GeoIpProcessorDescriptor TargetField(Field field) => Assign(field, (a, v) => a.TargetField = v);
public GeoIpProcessorDescriptor TargetField(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.TargetField = v);
public GeoIpProcessorDescriptor DatabaseFile(string file) => Assign(file, (a, v) => a.DatabaseFile = v);
public GeoIpProcessorDescriptor Properties(IEnumerable properties) => Assign(properties, (a, v) => a.Properties = v);
public GeoIpProcessorDescriptor Properties(params string[] properties) => Assign(properties, (a, v) => a.Properties = v);
///
public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) => Assign(firstOnly, (a, v) => a.FirstOnly = v);
}
}