LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Client.RequestOptions Class Reference

A container for generalized request inputs. This type allows consumers to extend the request functionality by abstracting away from the default (built-in) request framework (e.g. RestSharp). More...

Public Member Functions

 RequestOptions ()
 Constructs a new instance of RequestOptions More...
 

Properties

Dictionary< string, string > PathParameters [get, set]
 Parameters to be bound to path parts of the Request's URL More...
 
Multimap< string, string > QueryParameters [get, set]
 Query parameters to be applied to the request. Keys may have 1 or more values associated. More...
 
Multimap< string, string > HeaderParameters [get, set]
 Header parameters to be applied to the request. Keys may have 1 or more values associated. More...
 
Dictionary< string, string > FormParameters [get, set]
 Form parameters to be sent along with the request. More...
 
Multimap< string, Stream > FileParameters [get, set]
 File parameters to be sent along with the request. More...
 
string Operation [get, set]
 Operation associated with the request path. More...
 
int OperationIndex [get, set]
 Index associated with the operation. More...
 
Object Data [get, set]
 Any data associated with a request body. More...
 
bool OAuth [get, set]
 If request should be authenticated with OAuth. More...
 
int? TimeoutMs [get, set]
 The client timeout in milliseconds. If left unset the default timeout will be used More...
 
int? RateLimitRetries [get, set]
 The number of retries when being rate limited. If left unset the default number of rate limit retries will be used More...
 

Detailed Description

A container for generalized request inputs. This type allows consumers to extend the request functionality by abstracting away from the default (built-in) request framework (e.g. RestSharp).

Constructor & Destructor Documentation

◆ RequestOptions()

Lusid.Sdk.Client.RequestOptions.RequestOptions ( )
inline

Constructs a new instance of RequestOptions

Property Documentation

◆ Data

Object Lusid.Sdk.Client.RequestOptions.Data
getset

Any data associated with a request body.

◆ FileParameters

Multimap<string, Stream> Lusid.Sdk.Client.RequestOptions.FileParameters
getset

File parameters to be sent along with the request.

◆ FormParameters

Dictionary<string, string> Lusid.Sdk.Client.RequestOptions.FormParameters
getset

Form parameters to be sent along with the request.

◆ HeaderParameters

Multimap<string, string> Lusid.Sdk.Client.RequestOptions.HeaderParameters
getset

Header parameters to be applied to the request. Keys may have 1 or more values associated.

◆ OAuth

bool Lusid.Sdk.Client.RequestOptions.OAuth
getset

If request should be authenticated with OAuth.

◆ Operation

string Lusid.Sdk.Client.RequestOptions.Operation
getset

Operation associated with the request path.

◆ OperationIndex

int Lusid.Sdk.Client.RequestOptions.OperationIndex
getset

Index associated with the operation.

◆ PathParameters

Dictionary<string, string> Lusid.Sdk.Client.RequestOptions.PathParameters
getset

Parameters to be bound to path parts of the Request's URL

◆ QueryParameters

Multimap<string, string> Lusid.Sdk.Client.RequestOptions.QueryParameters
getset

Query parameters to be applied to the request. Keys may have 1 or more values associated.

◆ RateLimitRetries

int? Lusid.Sdk.Client.RequestOptions.RateLimitRetries
getset

The number of retries when being rate limited. If left unset the default number of rate limit retries will be used

◆ TimeoutMs

int? Lusid.Sdk.Client.RequestOptions.TimeoutMs
getset

The client timeout in milliseconds. If left unset the default timeout will be used


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