/* 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.Runtime.Serialization;
using OpenSearch.Net.Utf8Json;

namespace OpenSearch.Client
{
	/// <summary>
	/// Properties of a mapping for a property type to a document field that has doc_values in OpenSearch
	/// </summary>
	[InterfaceDataContract]
	public interface IDocValuesProperty : ICoreProperty
	{
		/// <summary>
		/// Whether to persist the value at index time in a columnar data structure (referred to as doc_values in Lucene)
		/// which makes the value available for efficient sorting and aggregations. Default is <c>true</c>.
		/// </summary>
		[DataMember(Name ="doc_values")]
		bool? DocValues { get; set; }
	}

	/// <inheritdoc cref="IDocValuesProperty" />
	public abstract class DocValuesPropertyBase : CorePropertyBase, IDocValuesProperty
	{
		protected DocValuesPropertyBase(FieldType type) : base(type) { }

		/// <inheritdoc />
		public bool? DocValues { get; set; }
	}
}