/* 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.Utf8Json;
namespace OpenSearch.Client.Specification.IngestApi
{
///
/// Extracts fields from CSV line out of a single text field within a document.
/// Any empty field in CSV will be skipped.
///
[InterfaceDataContract]
public interface ICsvProcessor : IProcessor
{
///
/// The field to extract data from
///
[DataMember(Name ="field")]
Field Field { get; set; }
///
/// The array of fields to assign extracted values to.
///
[DataMember(Name ="target_fields")]
Fields TargetFields { get; set; }
///
/// Separator used in CSV, has to be single character string. Defaults to ,
///
[DataMember(Name = "separator")]
string Separator { get; set; }
///
/// Quote used in CSV, has to be single character string. Defaults to "
///
[DataMember(Name = "quote")]
string Quote { 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; }
///
/// Trim whitespaces in unquoted fields. Default is false;
///
[DataMember(Name = "trim")]
bool? Trim { get; set; }
///
/// Value used to fill empty fields, empty fields will be skipped if this is not provided.
/// Empty field is one with no value (2 consecutive separators) or empty quotes (`""`)
///
[DataMember(Name = "empty_value")]
object EmptyValue { get; set; }
}
///
public class CsvProcessor : ProcessorBase, ICsvProcessor
{
///
public Field Field { get; set; }
///
public Fields TargetFields { get; set; }
///
public string Separator { get; set; }
///
public string Quote { get; set; }
///
public bool? IgnoreMissing { get; set; }
///
public bool? Trim { get; set; }
///
public object EmptyValue { get; set; }
///
protected override string Name => "csv";
}
///
public class CsvProcessorDescriptor : ProcessorDescriptorBase, ICsvProcessor>, ICsvProcessor
where T : class
{
protected override string Name => "csv";
Field ICsvProcessor.Field { get; set; }
Fields ICsvProcessor.TargetFields { get; set; }
bool? ICsvProcessor.IgnoreMissing { get; set; }
string ICsvProcessor.Quote { get; set; }
string ICsvProcessor.Separator { get; set; }
bool? ICsvProcessor.Trim { get; set; }
object ICsvProcessor.EmptyValue { get; set; }
///
public CsvProcessorDescriptor Field(Field field) => Assign(field, (a, v) => a.Field = v);
///
public CsvProcessorDescriptor Field(Expression> objectPath) =>
Assign(objectPath, (a, v) => a.Field = v);
///
public CsvProcessorDescriptor TargetFields(Func, IPromise> targetFields) =>
Assign(targetFields, (a, v) => a.TargetFields = v?.Invoke(new FieldsDescriptor())?.Value);
///
public CsvProcessorDescriptor TargetFields(Fields targetFields) => Assign(targetFields, (a, v) => a.TargetFields = v);
///
public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) => Assign(ignoreMissing, (a, v) => a.IgnoreMissing = v);
///
public CsvProcessorDescriptor Trim(bool? trim = true) => Assign(trim, (a, v) => a.Trim = v);
///
public CsvProcessorDescriptor Quote(string quote) => Assign(quote, (a, v) => a.Quote = v);
///
public CsvProcessorDescriptor Separator(string separator) => Assign(separator, (a, v) => a.Separator = v);
///
public CsvProcessorDescriptor EmptyValue(object value) => Assign(value, (a, v) => a.EmptyValue = v);
}
}