csharp-functions.IReadableConfiguration.mustache Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.7.0
{{>partial_header}}

using System;
using System.Collections.Generic;
using System.Net;
using System.Security.Cryptography.X509Certificates;

namespace {{packageName}}.Client
{
    /// 
    /// Represents a readable-only configuration contract.
    /// 
    public interface IReadableConfiguration
    {
        /// 
        /// Gets the access token.
        /// 
        /// Access token.
        string AccessToken { get; }

        /// 
        /// Gets the API key.
        /// 
        /// API key.
        IDictionary ApiKey { get; }

        /// 
        /// Gets the API key prefix.
        /// 
        /// API key prefix.
        IDictionary ApiKeyPrefix { get; }

        /// 
        /// Gets the base path.
        /// 
        /// Base path.
        string BasePath { get; }

        /// 
        /// Gets the date time format.
        /// 
        /// Date time format.
        string DateTimeFormat { get; }

        /// 
        /// Gets the default header.
        /// 
        /// Default header.
        [Obsolete("Use DefaultHeaders instead.")]
        IDictionary DefaultHeader { get; }

        /// 
        /// Gets the default headers.
        /// 
        /// Default headers.
        IDictionary DefaultHeaders { get; }

        /// 
        /// Gets the temp folder path.
        /// 
        /// Temp folder path.
        string TempFolderPath { get; }

        /// 
        /// Gets the HTTP connection timeout (in milliseconds)
        /// 
        /// HTTP connection timeout.
        int Timeout { get; }

        /// 
        /// Gets the proxy.
        /// 
        /// Proxy.
        WebProxy Proxy { get; }

        /// 
        /// Gets the user agent.
        /// 
        /// User agent.
        string UserAgent { get; }

        /// 
        /// Gets the username.
        /// 
        /// Username.
        string Username { get; }

        /// 
        /// Gets the password.
        /// 
        /// Password.
        string Password { get; }

        /// 
        /// Gets the API key with prefix.
        /// 
        /// API key identifier (authentication scheme).
        /// API key with prefix.
        string GetApiKeyWithPrefix(string apiKeyIdentifier);

        /// 
        /// Gets certificate collection to be sent with requests.
        /// 
        /// X509 Certificate collection.
        X509CertificateCollection ClientCertificates { get; }
        {{#hasHttpSignatureMethods}}

        /// 
        /// Gets the HttpSigning configuration
        /// 
        HttpSigningConfiguration HttpSigningConfiguration { get; }
        {{/hasHttpSignatureMethods}}
    }
}