GlobalConfiguration provides a compile-time extension point for globally configuring API Clients. More...
Inheritance diagram for Lusid.Sdk.Client.GlobalConfiguration:
Public Member Functions | |
| GlobalConfiguration (IDictionary< string, string > defaultHeader, IDictionary< string, string > apiKey, IDictionary< string, string > apiKeyPrefix, string basePath="http://localhost:3000/api") | |
 Public Member Functions inherited from Lusid.Sdk.Client.Configuration | |
| Configuration () | |
| Initializes a new instance of the Configuration class More... | |
| Configuration (IDictionary< string, string > defaultHeaders, IDictionary< string, string > apiKey, IDictionary< string, string > apiKeyPrefix, string basePath="http://local-unit-test-server.lusid.com:39100") | |
| Initializes a new instance of the Configuration class More... | |
| string | GetApiKeyWithPrefix (string apiKeyIdentifier) |
| Gets the API key with prefix. More... | |
| string | GetServerUrl (int index) |
| Returns URL based on server settings without providing values for the variables More... | |
| string | GetServerUrl (int index, Dictionary< string, string > inputVariables) |
| Returns URL based on server settings. More... | |
| void | AddApiKey (string key, string value) |
| Add Api Key Header. More... | |
| void | AddApiKeyPrefix (string key, string value) |
| Sets the API key prefix. More... | |
Properties | |
| static IReadableConfiguration | Instance [get, set] |
| Gets or sets the default Configuration. More... | |
| Properties inherited from Lusid.Sdk.Client.Configuration | |
| virtual string | BasePath [get, set] |
| Gets or sets the base path for API access. More... | |
| virtual IDictionary< string, string > | DefaultHeader [get, set] |
| Gets or sets the default header. More... | |
| virtual IDictionary< string, string > | DefaultHeaders [get, set] |
| Gets or sets the default headers. More... | |
| virtual int | Timeout [get, set] |
| Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. More... | |
| virtual WebProxy | Proxy [get, set] |
| Gets or sets the proxy More... | |
| virtual string | UserAgent [get, set] |
| Gets or sets the HTTP user agent. More... | |
| virtual string | Username [get, set] |
| Gets or sets the username (HTTP basic authentication). More... | |
| virtual string | Password [get, set] |
| Gets or sets the password (HTTP basic authentication). More... | |
| X509CertificateCollection | ClientCertificates [get, set] |
| Gets or sets certificate collection to be sent with requests. More... | |
| virtual string | AccessToken [get, set] |
| Gets or sets the access token for OAuth2 authentication. More... | |
| virtual string | TempFolderPath [get, set] |
| Gets or sets the temporary folder path to store the files downloaded from the server. More... | |
| virtual string | DateTimeFormat [get, set] |
| Gets or sets the date time format used when serializing in the ApiClient By default, it's set to ISO 8601 - "o", for others see: https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx No validation is done to ensure that the string you're providing is valid More... | |
| virtual IDictionary< string, string > | ApiKeyPrefix [get, set] |
| Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. More... | |
| virtual IDictionary< string, string > | ApiKey [get, set] |
| Gets or sets the API key based on the authentication name. More... | |
| virtual IList< IReadOnlyDictionary< string, object > > | Servers [get, set] |
| Gets or sets the servers. More... | |
| Properties inherited from Lusid.Sdk.Client.IReadableConfiguration | |
| string | AccessToken [get] |
| Gets the access token. More... | |
| IDictionary< string, string > | ApiKey [get] |
| Gets the API key. More... | |
| IDictionary< string, string > | ApiKeyPrefix [get] |
| Gets the API key prefix. More... | |
| string | BasePath [get] |
| Gets the base path. More... | |
| string | DateTimeFormat [get] |
| Gets the date time format. More... | |
| IDictionary< string, string > | DefaultHeader [get] |
| Gets the default header. More... | |
| IDictionary< string, string > | DefaultHeaders [get] |
| Gets the default headers. More... | |
| string | TempFolderPath [get] |
| Gets the temp folder path. More... | |
| int | Timeout [get] |
| Gets the HTTP connection timeout (in milliseconds) More... | |
| WebProxy | Proxy [get] |
| Gets the proxy. More... | |
| string | UserAgent [get] |
| Gets the user agent. More... | |
| string | Username [get] |
| Gets the username. More... | |
| string | Password [get] |
| Gets the password. More... | |
| X509CertificateCollection | ClientCertificates [get] |
| Gets certificate collection to be sent with requests. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Lusid.Sdk.Client.Configuration | |
| static String | ToDebugReport () |
| Returns a string with essential information for debugging. More... | |
| static IReadableConfiguration | MergeConfigurations (IReadableConfiguration first, IReadableConfiguration second) |
| Merge configurations. More... | |
| Public Attributes inherited from Lusid.Sdk.Client.Configuration | |
| const string | Version = "0.11.3328-mark" |
| Version of the package. More... | |
| const string | ISO8601_DATETIME_FORMAT = "o" |
| Identifier for ISO 8601 DateTime Format More... | |
| Static Public Attributes inherited from Lusid.Sdk.Client.Configuration | |
| static readonly ExceptionFactory | DefaultExceptionFactory |
| Default creation of exceptions for a given method name and response object More... | |
Detailed Description
GlobalConfiguration provides a compile-time extension point for globally configuring API Clients.
A customized implementation via partial class may reside in another file and may be excluded from automatic generation via a .openapi-generator-ignore file.
Property Documentation
◆ Instance
|
staticgetset |
Gets or sets the default Configuration.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Client/GlobalConfiguration.cs
