bindings/dotnet/OpenDAL/ServiceConfig/Abstractions/IServiceConfig.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */

namespace OpenDAL.ServiceConfig.Abstractions;

/// <summary>
/// Represents a typed backend configuration that can be converted to OpenDAL options.
/// </summary>
public interface IServiceConfig
{
    /// <summary>
    /// Gets backend scheme name, such as <c>memory</c> or <c>fs</c>.
    /// </summary>
    string Scheme { get; }

    /// <summary>
    /// Converts this configuration into key/value options passed to native OpenDAL.
    /// </summary>
    /// <returns>Backend-specific option map.</returns>
    IReadOnlyDictionary<string, string> ToOptions();
}