LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< MarketDataFieldConfigurationGetMarketDataFieldConfigurationAsync (string marketDataCategory, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< MarketDataFieldConfiguration > > GetMarketDataFieldConfigurationWithHttpInfoAsync (string marketDataCategory, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration More...
 
System.Threading.Tasks.Task< MarketDataFieldConfigurationUpdateMarketDataFieldConfigurationAsync (string marketDataCategory, UpdateMarketDataFieldConfigurationRequest updateMarketDataFieldConfigurationRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< MarketDataFieldConfiguration > > UpdateMarketDataFieldConfigurationWithHttpInfoAsync (string marketDataCategory, UpdateMarketDataFieldConfigurationRequest updateMarketDataFieldConfigurationRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ GetMarketDataFieldConfigurationAsync()

System.Threading.Tasks.Task<MarketDataFieldConfiguration> Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync.GetMarketDataFieldConfigurationAsync ( string  marketDataCategory,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration

Retrieve the market data field configuration for a given market data category. If the configuration does not yet exist, an empty configuration will be returned.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
asAtThe asAt datetime at which to retrieve the configuration. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ GetMarketDataFieldConfigurationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<MarketDataFieldConfiguration> > Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync.GetMarketDataFieldConfigurationWithHttpInfoAsync ( string  marketDataCategory,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration

Retrieve the market data field configuration for a given market data category. If the configuration does not yet exist, an empty configuration will be returned.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
asAtThe asAt datetime at which to retrieve the configuration. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (MarketDataFieldConfiguration)

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ UpdateMarketDataFieldConfigurationAsync()

System.Threading.Tasks.Task<MarketDataFieldConfiguration> Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync.UpdateMarketDataFieldConfigurationAsync ( string  marketDataCategory,
UpdateMarketDataFieldConfigurationRequest  updateMarketDataFieldConfigurationRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
updateMarketDataFieldConfigurationRequestThe metadata fields to add, update, or remove.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ UpdateMarketDataFieldConfigurationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<MarketDataFieldConfiguration> > Lusid.Sdk.Api.IMarketDataFieldConfigurationApiAsync.UpdateMarketDataFieldConfigurationWithHttpInfoAsync ( string  marketDataCategory,
UpdateMarketDataFieldConfigurationRequest  updateMarketDataFieldConfigurationRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
updateMarketDataFieldConfigurationRequestThe metadata fields to add, update, or remove.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (MarketDataFieldConfiguration)

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.


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