/* 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.Linq.Expressions;
using System.Runtime.Serialization;
using OpenSearch.Net;
using OpenSearch.Net.Utf8Json;
namespace OpenSearch.Client.Specification.IngestApi
{
///
/// Converts a field in the currently ingested document to a different type,
/// such as converting a string to an integer.
/// If the field value is an array, all members will be converted.
///
[InterfaceDataContract]
public interface IConvertProcessor : IProcessor
{
///
/// The field whose value is to be converted
///
[DataMember(Name ="field")]
Field Field { get; set; }
///
/// The field to assign the converted value to, by default field is updated in-place
///
[DataMember(Name ="target_field")]
Field TargetField { get; set; }
///
/// The type to convert the existing value to
///
[DataMember(Name ="type")]
ConvertProcessorType? Type { get; set; }
///
/// If true and does not exist or is null,
/// the processor quietly exits without modifying the document. Default is false
///
[DataMember(Name = "ignore_missing")]
bool? IgnoreMissing { get; set; }
}
public class ConvertProcessor : ProcessorBase, IConvertProcessor
{
///
public Field Field { get; set; }
///
public Field TargetField { get; set; }
///
public ConvertProcessorType? Type { get; set; }
///
public bool? IgnoreMissing { get; set; }
///
protected override string Name => "convert";
}
public class ConvertProcessorDescriptor : ProcessorDescriptorBase, IConvertProcessor>, IConvertProcessor
where T : class
{
protected override string Name => "convert";
Field IConvertProcessor.Field { get; set; }
Field IConvertProcessor.TargetField { get; set; }
bool? IConvertProcessor.IgnoreMissing { get; set; }
ConvertProcessorType? IConvertProcessor.Type { get; set; }
///
public ConvertProcessorDescriptor Field(Field field) => Assign(field, (a, v) => a.Field = v);
///
public ConvertProcessorDescriptor Field(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.Field = v);
///
public ConvertProcessorDescriptor TargetField(Field field) => Assign(field, (a, v) => a.TargetField = v);
///
public ConvertProcessorDescriptor TargetField(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.TargetField = v);
///
public ConvertProcessorDescriptor Type(ConvertProcessorType? type) => Assign(type, (a, v) => a.Type = v);
///
public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) => Assign(ignoreMissing, (a, v) => a.IgnoreMissing = v);
}
[StringEnum]
public enum ConvertProcessorType
{
[EnumMember(Value = "integer")]
Integer,
[EnumMember(Value = "long")]
Long,
[EnumMember(Value = "float")]
Float,
[EnumMember(Value = "double")]
Double,
[EnumMember(Value = "string")]
String,
[EnumMember(Value = "boolean")]
Boolean,
[EnumMember(Value = "auto")]
Auto
}
}