Represents a readable-only configuration contract. More...

Inheritance diagram for Lusid.Sdk.Client.IReadableConfiguration:

[legend]

Public Member Functions
string	GetApiKeyWithPrefix (string apiKeyIdentifier)
	Gets the API key with prefix. More...

string	GetOperationServerUrl (string operation, int index)
	Gets the Operation server url at the provided index. More...

Properties
string	AccessToken `[get]`
	Gets the access token. More...

string	OAuthTokenUrl `[get]`
	Gets the OAuth token URL. More...

string	OAuthClientId `[get]`
	Gets the OAuth client ID. More...

string	OAuthClientSecret `[get]`
	Gets the OAuth client secret. More...

OAuthFlow?	OAuthFlow `[get]`
	Gets the OAuth flow. 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	TimeoutMs `[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...

IReadOnlyDictionary< string, List< IReadOnlyDictionary< string, object > > >	OperationServers `[get]`
	Get the servers associated with the operation. More...

X509CertificateCollection	ClientCertificates `[get]`
	Gets certificate collection to be sent with requests. More...

int	RateLimitRetries `[get]`
	Gets the number of retries when being rate limited More...

Detailed Description

Represents a readable-only configuration contract.

Member Function Documentation

◆ GetApiKeyWithPrefix()

string Lusid.Sdk.Client.IReadableConfiguration.GetApiKeyWithPrefix ( string apiKeyIdentifier )

Gets the API key with prefix.

Parameters

apiKeyIdentifier API key identifier (authentication scheme).

Returns: API key with prefix.

Implemented in Lusid.Sdk.Client.Configuration.

◆ GetOperationServerUrl()

string Lusid.Sdk.Client.IReadableConfiguration.GetOperationServerUrl	(	string	operation,
		int	index
	)

Gets the Operation server url at the provided index.

Parameters

operation	Operation server name.
index	Index of the operation server settings.

Returns

Implemented in Lusid.Sdk.Client.Configuration.

Property Documentation

◆ AccessToken

string Lusid.Sdk.Client.IReadableConfiguration.AccessToken

get

Gets the access token.

Access token.

◆ ApiKey

IDictionary<string, string> Lusid.Sdk.Client.IReadableConfiguration.ApiKey

get

Gets the API key.

API key.

◆ ApiKeyPrefix

IDictionary<string, string> Lusid.Sdk.Client.IReadableConfiguration.ApiKeyPrefix

get

Gets the API key prefix.

API key prefix.

◆ BasePath

string Lusid.Sdk.Client.IReadableConfiguration.BasePath

get

Gets the base path.

Base path.

◆ ClientCertificates

X509CertificateCollection Lusid.Sdk.Client.IReadableConfiguration.ClientCertificates

get

Gets certificate collection to be sent with requests.

X509 Certificate collection.

◆ DateTimeFormat

string Lusid.Sdk.Client.IReadableConfiguration.DateTimeFormat

get

Gets the date time format.

Date time format.

◆ DefaultHeader

IDictionary<string, string> Lusid.Sdk.Client.IReadableConfiguration.DefaultHeader

get

Gets the default header.

Default header.

◆ DefaultHeaders

IDictionary<string, string> Lusid.Sdk.Client.IReadableConfiguration.DefaultHeaders

get

Gets the default headers.

Default headers.

◆ OAuthClientId

string Lusid.Sdk.Client.IReadableConfiguration.OAuthClientId

get

Gets the OAuth client ID.

OAuth Client ID.

◆ OAuthClientSecret

string Lusid.Sdk.Client.IReadableConfiguration.OAuthClientSecret

get

Gets the OAuth client secret.

OAuth Client Secret.

◆ OAuthFlow

OAuthFlow? Lusid.Sdk.Client.IReadableConfiguration.OAuthFlow

get

Gets the OAuth flow.

OAuth Flow.

◆ OAuthTokenUrl

string Lusid.Sdk.Client.IReadableConfiguration.OAuthTokenUrl

get

Gets the OAuth token URL.

OAuth Token URL.

◆ OperationServers

IReadOnlyDictionary<string, List<IReadOnlyDictionary<string, object> > > Lusid.Sdk.Client.IReadableConfiguration.OperationServers

get

Get the servers associated with the operation.

Operation servers.

◆ Password

string Lusid.Sdk.Client.IReadableConfiguration.Password

get

Gets the password.

Password.

◆ Proxy

WebProxy Lusid.Sdk.Client.IReadableConfiguration.Proxy

get

Gets the proxy.

Proxy.

◆ RateLimitRetries

int Lusid.Sdk.Client.IReadableConfiguration.RateLimitRetries

get

Gets the number of retries when being rate limited

◆ TempFolderPath

string Lusid.Sdk.Client.IReadableConfiguration.TempFolderPath

get

Gets the temp folder path.

Temp folder path.

◆ TimeoutMs

int Lusid.Sdk.Client.IReadableConfiguration.TimeoutMs

get

Gets the HTTP connection timeout (in milliseconds)

HTTP connection timeout.

◆ UserAgent

string Lusid.Sdk.Client.IReadableConfiguration.UserAgent

get

Gets the user agent.

User agent.

◆ Username

string Lusid.Sdk.Client.IReadableConfiguration.Username

get

Gets the username.

Username.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Client/IReadableConfiguration.cs

Public Member Functions

Properties