Microsoft.Azure.Cosmos/src/Resource/Settings/FullTextIndexPath.cs

//------------------------------------------------------------
// Copyright (c) Microsoft Corporation.  All rights reserved.
//------------------------------------------------------------
namespace Microsoft.Azure.Cosmos
{
    using System.Collections.Generic;
    using Microsoft.Azure.Documents;
    using Newtonsoft.Json;
    using Newtonsoft.Json.Linq;

    /// <summary>
    /// DOM for a full text index path. A full text index path is used in a full text index.
    /// </summary>
    /// <example>
    /// <![CDATA[
    /// "indexingPolicy": {
    ///     "includedPaths": [
    ///         {
    ///             "path": "/*"
    ///         }
    ///     ],
    ///     "excludedPaths": [
    ///         {
    ///             "path": "/embeddings/vector/*"
    ///         }
    ///     ],
    ///     "fullTextIndexes": [
    ///         {
    ///             "path": "/v1/path1",
    ///         },
    ///         {
    ///             "path": "/v2/path2/text2",
    ///         },
    ///         {
    ///             "path": "/v3",
    ///         }
    ///     ]
    /// }
    /// ]]>
    /// </example>
    public sealed class FullTextIndexPath
    {
        /// <summary>
        /// Gets or sets the full path in a document used for full text indexing.
        /// </summary>
        [JsonProperty(PropertyName = Constants.Properties.Path)]
        public string Path { get; set; }

        /// <summary>
        /// This contains additional values for scenarios where the SDK is not aware of new fields.
        /// This ensures that if resource is read and updated none of the fields will be lost in the process.
        /// </summary>
        [JsonExtensionData]
        internal IDictionary<string, JToken> AdditionalProperties { get; private set; }
    }
}