Lusid.Sdk.Model.AggregateSpec Class Reference

AggregateSpec More...

Inheritance diagram for Lusid.Sdk.Model.AggregateSpec:

Public Types
enum class	OpEnum {   Sum = 1 , DefaultSum = 2 , Proportion = 3 , Average = 4 ,   Count = 5 , Min = 6 , Max = 7 , Value = 8 ,   SumOfPositiveValues = 9 , SumOfNegativeValues = 10 , SumOfAbsoluteValues = 11 , ProportionOfAbsoluteValues = 12 ,   SumCumulativeInAdvance = 13 , SumCumulativeInArrears = 14 }
	Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears. More...

Public Member Functions
	AggregateSpec (string key=default(string), OpEnum op=default(OpEnum), Dictionary< string, Object > options=default(Dictionary< string, Object >))
	Initializes a new instance of the AggregateSpec 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 (AggregateSpec input)
	Returns true if AggregateSpec instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

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

Properties
OpEnum	Op [get, set]
	Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears. More...
string	Key [get, set]
	The key that uniquely identifies a queryable address in Lusid. More...
Dictionary< string, Object >	Options [get, set]
	Additional options to apply when performing computations. Options that do not apply to the Key will be ignored. Option values can be boolean, numeric, string or date-time. More...

Detailed Description

AggregateSpec

Member Enumeration Documentation

OpEnum

enum Lusid.Sdk.Model.AggregateSpec.OpEnum

strong

Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears.

Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears.

Enumerator
Sum	Enum Sum for value: Sum
DefaultSum	Enum DefaultSum for value: DefaultSum
Proportion	Enum Proportion for value: Proportion
Average	Enum Average for value: Average
Count	Enum Count for value: Count
Min	Enum Min for value: Min
Max	Enum Max for value: Max
Value	Enum Value for value: Value
SumOfPositiveValues	Enum SumOfPositiveValues for value: SumOfPositiveValues
SumOfNegativeValues	Enum SumOfNegativeValues for value: SumOfNegativeValues
SumOfAbsoluteValues	Enum SumOfAbsoluteValues for value: SumOfAbsoluteValues
ProportionOfAbsoluteValues	Enum ProportionOfAbsoluteValues for value: ProportionOfAbsoluteValues
SumCumulativeInAdvance	Enum SumCumulativeInAdvance for value: SumCumulativeInAdvance
SumCumulativeInArrears	Enum SumCumulativeInArrears for value: SumCumulativeInArrears

Constructor & Destructor Documentation

AggregateSpec() [1/2]

Lusid.Sdk.Model.AggregateSpec.AggregateSpec ( )

inlineprotected

Initializes a new instance of the AggregateSpec class.

AggregateSpec() [2/2]

Lusid.Sdk.Model.AggregateSpec.AggregateSpec ( string  key = default(string), OpEnum  op = default(OpEnum), Dictionary< string, Object >  options = default(Dictionary<string, Object>)  )

inline

Initializes a new instance of the AggregateSpec class.

Parameters

key	The key that uniquely identifies a queryable address in Lusid. (required).
op	Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears. (required).
options	Additional options to apply when performing computations. Options that do not apply to the Key will be ignored. Option values can be boolean, numeric, string or date-time..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if AggregateSpec instances are equal

Parameters

input

Instance of AggregateSpec to be compared

Returns

Boolean

Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

Key

string Lusid.Sdk.Model.AggregateSpec.Key

getset

The key that uniquely identifies a queryable address in Lusid.

The key that uniquely identifies a queryable address in Lusid.

Op

OpEnum Lusid.Sdk.Model.AggregateSpec.Op

getset

Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears.

Available values: Sum, DefaultSum, Proportion, Average, Count, Min, Max, Value, SumOfPositiveValues, SumOfNegativeValues, SumOfAbsoluteValues, ProportionOfAbsoluteValues, SumCumulativeInAdvance, SumCumulativeInArrears.

Options

Dictionary<string, Object> Lusid.Sdk.Model.AggregateSpec.Options

getset

Additional options to apply when performing computations. Options that do not apply to the Key will be ignored. Option values can be boolean, numeric, string or date-time.

Additional options to apply when performing computations. Options that do not apply to the Key will be ignored. Option values can be boolean, numeric, string or date-time.

---

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