Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.QueryableKeysApi:

[legend]

Public Member Functions
	QueryableKeysApi ()
	Initializes a new instance of the QueryableKeysApi class. More...

	QueryableKeysApi (string basePath)
	Initializes a new instance of the QueryableKeysApi class. More...

	QueryableKeysApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the QueryableKeysApi class using Configuration object More...

	QueryableKeysApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the QueryableKeysApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

ResourceListOfQueryableKey	GetAllQueryableKeys (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfQueryableKey >	GetAllQueryableKeysWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, More...

async System.Threading.Tasks.Task< ResourceListOfQueryableKey >	GetAllQueryableKeysAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfQueryableKey > >	GetAllQueryableKeysWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ QueryableKeysApi() [1/4]

Lusid.Sdk.Api.QueryableKeysApi.QueryableKeysApi ( )

inline

Initializes a new instance of the QueryableKeysApi class.

Returns

◆ QueryableKeysApi() [2/4]

Lusid.Sdk.Api.QueryableKeysApi.QueryableKeysApi ( string basePath )

inline

Initializes a new instance of the QueryableKeysApi class.

Returns

◆ QueryableKeysApi() [3/4]

Lusid.Sdk.Api.QueryableKeysApi.QueryableKeysApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the QueryableKeysApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ QueryableKeysApi() [4/4]

Lusid.Sdk.Api.QueryableKeysApi.QueryableKeysApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the QueryableKeysApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetAllQueryableKeys()

ResourceListOfQueryableKey Lusid.Sdk.Api.QueryableKeysApi.GetAllQueryableKeys	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	For user defined DerivedValuation keys. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfQueryableKey

Implements Lusid.Sdk.Api.IQueryableKeysApiSync.

◆ GetAllQueryableKeysAsync()

async System.Threading.Tasks.Task<ResourceListOfQueryableKey> Lusid.Sdk.Api.QueryableKeysApi.GetAllQueryableKeysAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	For user defined DerivedValuation keys. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfQueryableKey

Implements Lusid.Sdk.Api.IQueryableKeysApiAsync.

◆ GetAllQueryableKeysWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfQueryableKey> Lusid.Sdk.Api.QueryableKeysApi.GetAllQueryableKeysWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	For user defined DerivedValuation keys. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfQueryableKey

Implements Lusid.Sdk.Api.IQueryableKeysApiSync.

◆ GetAllQueryableKeysWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfQueryableKey> > Lusid.Sdk.Api.QueryableKeysApi.GetAllQueryableKeysWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported "addresses" that can be queried from all endpoints. When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	For user defined DerivedValuation keys. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfQueryableKey)

Implements Lusid.Sdk.Api.IQueryableKeysApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.QueryableKeysApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.QueryableKeysApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.QueryableKeysApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.QueryableKeysApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.QueryableKeysApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ QueryableKeysApi() [1/4]

◆ QueryableKeysApi() [2/4]

◆ QueryableKeysApi() [3/4]

◆ QueryableKeysApi() [4/4]

Member Function Documentation

◆ GetAllQueryableKeys()

◆ GetAllQueryableKeysAsync()

◆ GetAllQueryableKeysWithHttpInfo()

◆ GetAllQueryableKeysWithHttpInfoAsync()

◆ GetBasePath()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory