bindings/dotnet/OpenDAL/ServiceConfig/GithubServiceConfig.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.
 */

// Generated from bindings/java ServiceConfig definitions.

using OpenDAL.ServiceConfig.Abstractions;

namespace OpenDAL.ServiceConfig
{
    /// <summary>
    /// Configuration for service github.
    /// </summary>
    public sealed class GithubServiceConfig : IServiceConfig
    {
        /// <summary>
        /// GitHub repo owner. required.
        /// </summary>
        public string? Owner { get; init; }
        /// <summary>
        /// GitHub repo name. required.
        /// </summary>
        public string? Repo { get; init; }
        /// <summary>
        /// root of this backend. All operations will happen under this root.
        /// </summary>
        public string? Root { get; init; }
        /// <summary>
        /// GitHub access_token. optional. If not provided, the backend will only support read operations for public repositories. And rate limit will be limited to 60 requests per hour.
        /// </summary>
        public string? Token { get; init; }

        public string Scheme => "github";

        public IReadOnlyDictionary<string, string> ToOptions()
        {
            var map = new Dictionary<string, string>();
            if (Owner is not null)
            {
                map["owner"] = Utilities.ToOptionString(Owner);
            }
            if (Repo is not null)
            {
                map["repo"] = Utilities.ToOptionString(Repo);
            }
            if (Root is not null)
            {
                map["root"] = Utilities.ToOptionString(Root);
            }
            if (Token is not null)
            {
                map["token"] = Utilities.ToOptionString(Token);
            }
            return map;
        }
    }

}