The request used in the AggregatedReturnsDispersionMetric. More...

Inheritance diagram for Lusid.Sdk.Model.AggregatedReturnsDispersionRequest:

Public Member Functions
	AggregatedReturnsDispersionRequest (DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), int yearsCount=default(int), List< ResourceId > returnIds=default(List< ResourceId >), ResourceId recipeId=default(ResourceId), string compositeMethod=default(string), string alternativeInceptionDate=default(string))
	Initializes a new instance of the AggregatedReturnsDispersionRequest 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 (AggregatedReturnsDispersionRequest input)
	Returns true if AggregatedReturnsDispersionRequest instances are equal More...

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

Properties
DateTimeOrCutLabel	ToEffectiveAt `[get, set]`
	The end date for when the you want the dispersion to be calculated. More...

int	YearsCount `[get, set]`
	For how many years to calculate the dispersion. Default to 10. 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	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...

Detailed Description

The request used in the AggregatedReturnsDispersionMetric.

Constructor & Destructor Documentation

◆ AggregatedReturnsDispersionRequest()

Lusid.Sdk.Model.AggregatedReturnsDispersionRequest.AggregatedReturnsDispersionRequest	(	DateTimeOrCutLabel	toEffectiveAt = `default(DateTimeOrCutLabel)`,
		int	yearsCount = `default(int)`,
		List< ResourceId >	returnIds = `default(List<ResourceId>)`,
		ResourceId	recipeId = `default(ResourceId)`,
		string	compositeMethod = `default(string)`,
		string	alternativeInceptionDate = `default(string)`
	)

inline

Initializes a new instance of the AggregatedReturnsDispersionRequest class.

Parameters

toEffectiveAt	The end date for when the you want the dispersion to be calculated..
yearsCount	For how many years to calculate the dispersion. Default to 10..
returnIds	The Scope and code of the returns..
recipeId	recipeId.
compositeMethod	The method used to calculate the Portfolio performance. Available values: Equal, Asset..
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..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if AggregatedReturnsDispersionRequest instances are equal

Parameters

input Instance of AggregatedReturnsDispersionRequest to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AlternativeInceptionDate

string Lusid.Sdk.Model.AggregatedReturnsDispersionRequest.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.AggregatedReturnsDispersionRequest.CompositeMethod

getset

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

◆ RecipeId

ResourceId Lusid.Sdk.Model.AggregatedReturnsDispersionRequest.RecipeId

getset

Gets or Sets RecipeId

◆ ReturnIds

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

getset

The Scope and code of the returns.

◆ ToEffectiveAt

DateTimeOrCutLabel Lusid.Sdk.Model.AggregatedReturnsDispersionRequest.ToEffectiveAt

getset

The end date for when the you want the dispersion to be calculated.

◆ YearsCount

int Lusid.Sdk.Model.AggregatedReturnsDispersionRequest.YearsCount

getset

For how many years to calculate the dispersion. Default to 10.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AggregatedReturnsDispersionRequest()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AlternativeInceptionDate

◆ CompositeMethod

◆ RecipeId

◆ ReturnIds

◆ ToEffectiveAt

◆ YearsCount