LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.InlineValuationRequest Class Reference

Specification object for the parameters of an inline valuation More...

Inheritance diagram for Lusid.Sdk.Model.InlineValuationRequest:
Inheritance graph
[legend]

Public Member Functions

 InlineValuationRequest (ResourceId recipeId=default(ResourceId), DateTimeOffset? asAt=default(DateTimeOffset?), List< AggregateSpec > metrics=default(List< AggregateSpec >), List< string > groupBy=default(List< string >), List< PropertyFilter > filters=default(List< PropertyFilter >), List< OrderBySpec > sort=default(List< OrderBySpec >), string reportCurrency=default(string), bool equipWithSubtotals=default(bool), bool returnResultAsExpandedTypes=default(bool), ValuationSchedule valuationSchedule=default(ValuationSchedule), List< WeightedInstrument > instruments=default(List< WeightedInstrument >), MarketDataOverrides marketDataOverrides=default(MarketDataOverrides), ResourceId corporateActionSourceId=default(ResourceId))
 Initializes a new instance of the InlineValuationRequest class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (InlineValuationRequest input)
 Returns true if InlineValuationRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 InlineValuationRequest ()
 Initializes a new instance of the InlineValuationRequest class. More...
 

Properties

ResourceId RecipeId [get, set]
 Gets or Sets RecipeId More...
 
DateTimeOffset? AsAt [get, set]
 The asAt date to use More...
 
List< AggregateSpecMetrics [get, set]
 The set of specifications to calculate or retrieve during the valuation and present in the results. For example: AggregateSpec(&#39;Valuation/PV&#39;,&#39;Sum&#39;) for returning the PV (present value) of holdings AggregateSpec(&#39;Holding/default/Units&#39;,&#39;Sum&#39;) for returning the units of holidays AggregateSpec(&#39;Instrument/default/LusidInstrumentId&#39;,&#39;Value&#39;) for returning the Lusid Instrument identifier More...
 
List< string > GroupBy [get, set]
 The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out. More...
 
List< PropertyFilterFilters [get, set]
 A set of filters to use to reduce the data found in a request. Equivalent to the &#39;where ...&#39; part of a Sql select statement. For example, filter a set of values within a given range or matching a particular value. More...
 
List< OrderBySpecSort [get, set]
 A (possibly empty/null) set of specifications for how to order the results. More...
 
string ReportCurrency [get, set]
 Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. If not present, then the currency of the relevant portfolio will be used in its place. More...
 
bool EquipWithSubtotals [get, set]
 Flag directing the Valuation call to populate the results with subtotals of aggregates. More...
 
bool ReturnResultAsExpandedTypes [get, set]
 Financially meaningful results can be presented as either simple flat types or more complex expanded types. For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied) or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example, the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false. More...
 
ValuationSchedule ValuationSchedule [get, set]
 Gets or Sets ValuationSchedule More...
 
List< WeightedInstrumentInstruments [get, set]
 The set of instruments, weighted by the quantities held that are required. It is identified by an identifier tag that can be used to identify it externally. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. More...
 
MarketDataOverrides MarketDataOverrides [get, set]
 Gets or Sets MarketDataOverrides More...
 
ResourceId CorporateActionSourceId [get, set]
 Gets or Sets CorporateActionSourceId More...
 

Detailed Description

Specification object for the parameters of an inline valuation

Constructor & Destructor Documentation

◆ InlineValuationRequest() [1/2]

Lusid.Sdk.Model.InlineValuationRequest.InlineValuationRequest ( )
inlineprotected

Initializes a new instance of the InlineValuationRequest class.

◆ InlineValuationRequest() [2/2]

Lusid.Sdk.Model.InlineValuationRequest.InlineValuationRequest ( ResourceId  recipeId = default(ResourceId),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< AggregateSpec metrics = default(List<AggregateSpec>),
List< string >  groupBy = default(List<string>),
List< PropertyFilter filters = default(List<PropertyFilter>),
List< OrderBySpec sort = default(List<OrderBySpec>),
string  reportCurrency = default(string),
bool  equipWithSubtotals = default(bool),
bool  returnResultAsExpandedTypes = default(bool),
ValuationSchedule  valuationSchedule = default(ValuationSchedule),
List< WeightedInstrument instruments = default(List<WeightedInstrument>),
MarketDataOverrides  marketDataOverrides = default(MarketDataOverrides),
ResourceId  corporateActionSourceId = default(ResourceId) 
)
inline

Initializes a new instance of the InlineValuationRequest class.

Parameters
recipeIdrecipeId.
asAtThe asAt date to use.
metricsThe set of specifications to calculate or retrieve during the valuation and present in the results. For example: AggregateSpec(&#39;Valuation/PV&#39;,&#39;Sum&#39;) for returning the PV (present value) of holdings AggregateSpec(&#39;Holding/default/Units&#39;,&#39;Sum&#39;) for returning the units of holidays AggregateSpec(&#39;Instrument/default/LusidInstrumentId&#39;,&#39;Value&#39;) for returning the Lusid Instrument identifier (required).
groupByThe set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out..
filtersA set of filters to use to reduce the data found in a request. Equivalent to the &#39;where ...&#39; part of a Sql select statement. For example, filter a set of values within a given range or matching a particular value..
sortA (possibly empty/null) set of specifications for how to order the results..
reportCurrencyThree letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. If not present, then the currency of the relevant portfolio will be used in its place..
equipWithSubtotalsFlag directing the Valuation call to populate the results with subtotals of aggregates..
returnResultAsExpandedTypesFinancially meaningful results can be presented as either simple flat types or more complex expanded types. For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied) or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example, the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false..
valuationSchedulevaluationSchedule.
instrumentsThe set of instruments, weighted by the quantities held that are required. It is identified by an identifier tag that can be used to identify it externally. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case. (required).
marketDataOverridesmarketDataOverrides.
corporateActionSourceIdcorporateActionSourceId.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InlineValuationRequest.Equals ( InlineValuationRequest  input)
inline

Returns true if InlineValuationRequest instances are equal

Parameters
inputInstance of InlineValuationRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InlineValuationRequest.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.InlineValuationRequest.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.InlineValuationRequest.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.InlineValuationRequest.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AsAt

DateTimeOffset? Lusid.Sdk.Model.InlineValuationRequest.AsAt
getset

The asAt date to use

The asAt date to use

◆ CorporateActionSourceId

ResourceId Lusid.Sdk.Model.InlineValuationRequest.CorporateActionSourceId
getset

Gets or Sets CorporateActionSourceId

◆ EquipWithSubtotals

bool Lusid.Sdk.Model.InlineValuationRequest.EquipWithSubtotals
getset

Flag directing the Valuation call to populate the results with subtotals of aggregates.

Flag directing the Valuation call to populate the results with subtotals of aggregates.

◆ Filters

List<PropertyFilter> Lusid.Sdk.Model.InlineValuationRequest.Filters
getset

A set of filters to use to reduce the data found in a request. Equivalent to the &#39;where ...&#39; part of a Sql select statement. For example, filter a set of values within a given range or matching a particular value.

A set of filters to use to reduce the data found in a request. Equivalent to the &#39;where ...&#39; part of a Sql select statement. For example, filter a set of values within a given range or matching a particular value.

◆ GroupBy

List<string> Lusid.Sdk.Model.InlineValuationRequest.GroupBy
getset

The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.

The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.

◆ Instruments

List<WeightedInstrument> Lusid.Sdk.Model.InlineValuationRequest.Instruments
getset

The set of instruments, weighted by the quantities held that are required. It is identified by an identifier tag that can be used to identify it externally. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case.

The set of instruments, weighted by the quantities held that are required. It is identified by an identifier tag that can be used to identify it externally. For a single, unique trade or transaction this can be thought of as equivalent to the transaction identifier, or a composite of the sub-holding keys for a regular sub-holding. When there are multiple transactions sharing the same underlying instrument such as purchase of shares on multiple dates where tax implications are different this would not be the case.

◆ MarketDataOverrides

MarketDataOverrides Lusid.Sdk.Model.InlineValuationRequest.MarketDataOverrides
getset

Gets or Sets MarketDataOverrides

◆ Metrics

List<AggregateSpec> Lusid.Sdk.Model.InlineValuationRequest.Metrics
getset

The set of specifications to calculate or retrieve during the valuation and present in the results. For example: AggregateSpec(&#39;Valuation/PV&#39;,&#39;Sum&#39;) for returning the PV (present value) of holdings AggregateSpec(&#39;Holding/default/Units&#39;,&#39;Sum&#39;) for returning the units of holidays AggregateSpec(&#39;Instrument/default/LusidInstrumentId&#39;,&#39;Value&#39;) for returning the Lusid Instrument identifier

The set of specifications to calculate or retrieve during the valuation and present in the results. For example: AggregateSpec(&#39;Valuation/PV&#39;,&#39;Sum&#39;) for returning the PV (present value) of holdings AggregateSpec(&#39;Holding/default/Units&#39;,&#39;Sum&#39;) for returning the units of holidays AggregateSpec(&#39;Instrument/default/LusidInstrumentId&#39;,&#39;Value&#39;) for returning the Lusid Instrument identifier

◆ RecipeId

ResourceId Lusid.Sdk.Model.InlineValuationRequest.RecipeId
getset

Gets or Sets RecipeId

◆ ReportCurrency

string Lusid.Sdk.Model.InlineValuationRequest.ReportCurrency
getset

Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. If not present, then the currency of the relevant portfolio will be used in its place.

Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. If not present, then the currency of the relevant portfolio will be used in its place.

◆ ReturnResultAsExpandedTypes

bool Lusid.Sdk.Model.InlineValuationRequest.ReturnResultAsExpandedTypes
getset

Financially meaningful results can be presented as either simple flat types or more complex expanded types. For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied) or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example, the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.

Financially meaningful results can be presented as either simple flat types or more complex expanded types. For example, the present value (PV) of a holding could be represented either as a simple decimal (with currency implied) or as a decimal-currency pair. This flag allows either representation to be returned. In the PV example, the returned value would be the decimal-currency pair if this flag is true, or the decimal only if this flag is false.

◆ Sort

List<OrderBySpec> Lusid.Sdk.Model.InlineValuationRequest.Sort
getset

A (possibly empty/null) set of specifications for how to order the results.

A (possibly empty/null) set of specifications for how to order the results.

◆ ValuationSchedule

ValuationSchedule Lusid.Sdk.Model.InlineValuationRequest.ValuationSchedule
getset

Gets or Sets ValuationSchedule


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