The request used in the AggregatedReturns. More...

Inheritance diagram for Lusid.Sdk.Model.AggregatedReturnsRequest:

Public Member Functions
	AggregatedReturnsRequest (List< PerformanceReturnsMetric > metrics=default(List< PerformanceReturnsMetric >), List< ResourceId > returnIds=default(List< ResourceId >), ResourceId recipeId=default(ResourceId), string compositeMethod=default(string), string period=default(string), string outputFrequency=default(string), string alternativeInceptionDate=default(string), List< string > holidayCalendars=default(List< string >), string currency=default(string), string runMode=default(string))
	Initializes a new instance of the AggregatedReturnsRequest 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 (AggregatedReturnsRequest input)
	Returns true if AggregatedReturnsRequest instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	AggregatedReturnsRequest ()
	Initializes a new instance of the AggregatedReturnsRequest class. More...

Properties
List< PerformanceReturnsMetric >	Metrics `[get, set]`
	A list of metrics to calculate in the AggregatedReturns. More...

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. Available values: Equal, Asset. More...

string	Period `[get, set]`
	The type of the returns used to calculate the aggregation result. Available values: Daily, Monthly. More...

string	OutputFrequency `[get, set]`
	The type of calculated output. Available values: Daily, Weekly, Monthly, Quarterly, HalfYearly, Yearly. More...

string	AlternativeInceptionDate `[get, set]`
	Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request. 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, '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. More...

string	Currency `[get, set]`
	Optional - either a string or a property. If provided, the results will be converted to the specified currency More...

string	RunMode `[get, set]`
	The dates the AggregatedReturns output will be calculated. Default value: ReturnData. Available values: ReturnData, WeekDays, AllDays, MonthEnd. More...

Detailed Description

The request used in the AggregatedReturns.

Constructor & Destructor Documentation

◆ AggregatedReturnsRequest() [1/2]

Lusid.Sdk.Model.AggregatedReturnsRequest.AggregatedReturnsRequest ( )

inlineprotected

Initializes a new instance of the AggregatedReturnsRequest class.

◆ AggregatedReturnsRequest() [2/2]

Lusid.Sdk.Model.AggregatedReturnsRequest.AggregatedReturnsRequest	(	List< PerformanceReturnsMetric >	metrics = `default(List<PerformanceReturnsMetric>)`,
		List< ResourceId >	returnIds = `default(List<ResourceId>)`,
		ResourceId	recipeId = `default(ResourceId)`,
		string	compositeMethod = `default(string)`,
		string	period = `default(string)`,
		string	outputFrequency = `default(string)`,
		string	alternativeInceptionDate = `default(string)`,
		List< string >	holidayCalendars = `default(List<string>)`,
		string	currency = `default(string)`,
		string	runMode = `default(string)`
	)

inline

Initializes a new instance of the AggregatedReturnsRequest class.

Parameters

metrics	A list of metrics to calculate in the AggregatedReturns. (required).
returnIds	The Scope and code of the returns..
recipeId	recipeId.
compositeMethod	The method used to calculate the Portfolio performance. Available values: Equal, Asset..
period	The type of the returns used to calculate the aggregation result. Available values: Daily, Monthly..
outputFrequency	The type of calculated output. Available values: Daily, Weekly, Monthly, Quarterly, HalfYearly, Yearly..
alternativeInceptionDate	Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request..
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.
runMode	The dates the AggregatedReturns output will be calculated. Default value: ReturnData. Available values: ReturnData, WeekDays, AllDays, MonthEnd..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if AggregatedReturnsRequest instances are equal

Parameters

input Instance of AggregatedReturnsRequest to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AlternativeInceptionDate

string Lusid.Sdk.Model.AggregatedReturnsRequest.AlternativeInceptionDate

getset

Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request.

◆ CompositeMethod

string Lusid.Sdk.Model.AggregatedReturnsRequest.CompositeMethod

getset

The method used to calculate the Portfolio performance. Available values: Equal, Asset.

◆ Currency

string Lusid.Sdk.Model.AggregatedReturnsRequest.Currency

getset

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

◆ HolidayCalendars

List<string> Lusid.Sdk.Model.AggregatedReturnsRequest.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.

◆ Metrics

List<PerformanceReturnsMetric> Lusid.Sdk.Model.AggregatedReturnsRequest.Metrics

getset

A list of metrics to calculate in the AggregatedReturns.

◆ OutputFrequency

string Lusid.Sdk.Model.AggregatedReturnsRequest.OutputFrequency

getset

The type of calculated output. Available values: Daily, Weekly, Monthly, Quarterly, HalfYearly, Yearly.

◆ Period

string Lusid.Sdk.Model.AggregatedReturnsRequest.Period

getset

The type of the returns used to calculate the aggregation result. Available values: Daily, Monthly.

◆ RecipeId

ResourceId Lusid.Sdk.Model.AggregatedReturnsRequest.RecipeId

getset

Gets or Sets RecipeId

◆ ReturnIds

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

getset

The Scope and code of the returns.

◆ RunMode

string Lusid.Sdk.Model.AggregatedReturnsRequest.RunMode

getset

The dates the AggregatedReturns output will be calculated. Default value: ReturnData. Available values: ReturnData, WeekDays, AllDays, MonthEnd.

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/AggregatedReturnsRequest.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AggregatedReturnsRequest() [1/2]

◆ AggregatedReturnsRequest() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AlternativeInceptionDate

◆ CompositeMethod

◆ Currency

◆ HolidayCalendars

◆ Metrics

◆ OutputFrequency

◆ Period

◆ RecipeId

◆ ReturnIds

◆ RunMode