/* 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;
using System.Linq.Expressions;
using System.Runtime.Serialization;
using OpenSearch.Net.Utf8Json;
namespace OpenSearch.Client.Specification.IngestApi
{
///
/// Processes elements in an array of unknown length.
/// All processors can operate on elements inside an array, but if all elements of
/// an array need to be processed in the same way, defining a processor for each
/// element becomes cumbersome and tricky because it is likely that the number of
/// elements in an array is unknown. For this reason the foreach processor exists.
/// By specifying the field holding array elements and a processor that defines what
/// should happen to each element, array fields can easily be preprocessed.
///
[InterfaceDataContract]
public interface IForeachProcessor : IProcessor
{
///
/// The array field
///
[DataMember(Name ="field")]
Field Field { get; set; }
///
/// The processor to execute against each field
///
[DataMember(Name ="processor")]
IProcessor Processor { 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 ForeachProcessor : ProcessorBase, IForeachProcessor
{
///
public Field Field { get; set; }
///
public IProcessor Processor { get; set; }
///
public bool? IgnoreMissing { get; set; }
protected override string Name => "foreach";
}
///
public class ForeachProcessorDescriptor
: ProcessorDescriptorBase, IForeachProcessor>, IForeachProcessor
where T : class
{
protected override string Name => "foreach";
Field IForeachProcessor.Field { get; set; }
IProcessor IForeachProcessor.Processor { get; set; }
bool? IForeachProcessor.IgnoreMissing { get; set; }
///
public ForeachProcessorDescriptor Field(Field field) => Assign(field, (a, v) => a.Field = v);
///
public ForeachProcessorDescriptor Field(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.Field = v);
///
public ForeachProcessorDescriptor Processor(Func>> selector) =>
Assign(selector, (a, v) => a.Processor = v?.Invoke(new ProcessorsDescriptor())?.Value?.FirstOrDefault());
///
public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) => Assign(ignoreMissing, (a, v) => a.IgnoreMissing = v);
}
}