Lusid.Sdk.Model.CompositeBreakdownRequest Class Reference

The request used in the GetCompositeBreakdown. More...

Inheritance diagram for Lusid.Sdk.Model.CompositeBreakdownRequest:

Public Member Functions
	CompositeBreakdownRequest (List< ResourceId > returnIds=default(List< ResourceId >), ResourceId recipeId=default(ResourceId), string compositeMethod=default(string), string period=default(string), List< string > holidayCalendars=default(List< string >), string currency=default(string))
	Initializes a new instance of the CompositeBreakdownRequest 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 (CompositeBreakdownRequest input)
	Returns true if CompositeBreakdownRequest instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Properties
List< ResourceId >	ReturnIds [get, set]
	The Scope and code of the returns. More...
ResourceId	RecipeId [get, set]
	Gets or Sets RecipeId More...
string	CompositeMethod [get, set]
	The method used to calculate the Portfolio performance: Equal/Asset. More...
string	Period [get, set]
	The type of the returns used to calculate the aggregation result: Daily/Monthly. More...
List< string >	HolidayCalendars [get, set]
	The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, for example, &#39;CoppClark&#39;. Note that when the calendars are not available (e.g. when the user has insufficient permissions), a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored. More...
string	Currency [get, set]
	Optional - either a string or a property. If provided, the results will be converted to the specified currency More...

Detailed Description

The request used in the GetCompositeBreakdown.

Constructor & Destructor Documentation

CompositeBreakdownRequest()

Lusid.Sdk.Model.CompositeBreakdownRequest.CompositeBreakdownRequest ( List< ResourceId >  returnIds = default(List<ResourceId>), ResourceId  recipeId = default(ResourceId), string  compositeMethod = default(string), string  period = default(string), List< string >  holidayCalendars = default(List<string>), string  currency = default(string)  )

inline

Initializes a new instance of the CompositeBreakdownRequest class.

Parameters

returnIds	The Scope and code of the returns..
recipeId	recipeId.
compositeMethod	The method used to calculate the Portfolio performance: Equal/Asset..
period	The type of the returns used to calculate the aggregation result: Daily/Monthly..
holidayCalendars	The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, for example, 'CoppClark'. Note that when the calendars are not available (e.g. when the user has insufficient permissions), a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored..
currency	Optional - either a string or a property. If provided, the results will be converted to the specified currency.

Member Function Documentation

Equals() [1/2]

bool Lusid.Sdk.Model.CompositeBreakdownRequest.Equals ( CompositeBreakdownRequest  input )

inline

Returns true if CompositeBreakdownRequest instances are equal

Parameters

input

Instance of CompositeBreakdownRequest to be compared

Returns

Boolean

Equals() [2/2]

override bool Lusid.Sdk.Model.CompositeBreakdownRequest.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.CompositeBreakdownRequest.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.CompositeBreakdownRequest.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.CompositeBreakdownRequest.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

CompositeMethod

string Lusid.Sdk.Model.CompositeBreakdownRequest.CompositeMethod

getset

The method used to calculate the Portfolio performance: Equal/Asset.

The method used to calculate the Portfolio performance: Equal/Asset.

Currency

string Lusid.Sdk.Model.CompositeBreakdownRequest.Currency

getset

Optional - either a string or a property. If provided, the results will be converted to the specified currency

Optional - either a string or a property. If provided, the results will be converted to the specified currency

HolidayCalendars

List<string> Lusid.Sdk.Model.CompositeBreakdownRequest.HolidayCalendars

getset

The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, for example, 'CoppClark'. Note that when the calendars are not available (e.g. when the user has insufficient permissions), a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.

The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, for example, 'CoppClark'. Note that when the calendars are not available (e.g. when the user has insufficient permissions), a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.

Period

string Lusid.Sdk.Model.CompositeBreakdownRequest.Period

getset

The type of the returns used to calculate the aggregation result: Daily/Monthly.

The type of the returns used to calculate the aggregation result: Daily/Monthly.

RecipeId

ResourceId Lusid.Sdk.Model.CompositeBreakdownRequest.RecipeId

getset

Gets or Sets RecipeId

ReturnIds

List<ResourceId> Lusid.Sdk.Model.CompositeBreakdownRequest.ReturnIds

getset

The Scope and code of the returns.

The Scope and code of the returns.

---

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/Model/CompositeBreakdownRequest.cs