Public Types | |
| enum class | TypeEnum { String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 , Boolean = 5 , ResultValue = 6 , Result0D = 7 , Json = 8 } |
| Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json More... | |
| enum class | FlattenedTypeEnum { String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 , Boolean = 5 , ResultValue = 6 , Result0D = 7 , Json = 8 } |
| Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json More... | |
Public Member Functions | |
| AggregationQuery (string addressKey=default(string), string description=default(string), string displayName=default(string), TypeEnum type=default(TypeEnum), FlattenedTypeEnum flattenedType=default(FlattenedTypeEnum), bool scalesWithHoldingQuantity=default(bool), string supportedOperations=default(string), string lifeCycleStatus=default(string), DateTimeOffset? removalDate=default(DateTimeOffset?), Dictionary< string, AddressKeyOptionDefinition > applicableOptions=default(Dictionary< string, AddressKeyOptionDefinition >)) | |
| Initializes a new instance of the AggregationQuery 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 (AggregationQuery input) |
| Returns true if AggregationQuery instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| AggregationQuery () | |
| Initializes a new instance of the AggregationQuery class. More... | |
Properties | |
| TypeEnum | Type [get, set] |
| Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json More... | |
| FlattenedTypeEnum | FlattenedType [get, set] |
| Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json More... | |
| string | AddressKey [get, set] |
| The address that is the query to be made into the system. e.g. a Valuation/PV or Instrument/MaturityDate More... | |
| string | Description [get, set] |
| What does the information that is being queried by the address mean. What is the address for. More... | |
| string | DisplayName [get, set] |
| The suggested name that the user would wish to put on to the returned information for visualisation in preference to the address. More... | |
| bool | ScalesWithHoldingQuantity [get, set] |
| Is the data scaled when it is for, e.g. a holding in an instrument. A key example would be the difference between price and PV. The present value of an instrument would scale with the quantity held. The price would be that for a hypothetical unit of that instrument, typically associated with the contract size. More... | |
| string | SupportedOperations [get, set] |
| When performing an aggregation operation, what column type operations can be performed on the data. For example, it makes sense to sum decimals but not strings. Either can be counted. With more complex types, e.g. ResultValues, operations may be linked to a semantic meaning such as the currency of the result. In such cases the operations may be supported but context specific. For example, it makes sense to sum PVs in a single currency but not when the currency is different. In such cases, an error would result (it being assumed that no fx rates for currency conversion were implicit in the context). More... | |
| string | LifeCycleStatus [get, set] |
| Within an API where an item can be accessed through an address or property, there is an associated status that determines whether the item is stable or likely to change. This status is one of [Experimental, Beta, EAP, Prod, Deprecated]. If the item is deprecated it will be removed on or after the associated DateTime RemovalDate field. That field will not otherwise be set. More... | |
| DateTimeOffset? | RemovalDate [get, set] |
| If the life cycle status is set to deprecated then this will be populated with the date on or after which removal of the address query will happen More... | |
| Dictionary< string, AddressKeyOptionDefinition > | ApplicableOptions [get, set] |
| A mapping from option names to the definition that the corresponding option value must match. More... | |
Detailed Description
Member Enumeration Documentation
◆ FlattenedTypeEnum
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
| Enumerator | |
|---|---|
| String | Enum String for value: String |
| Int | Enum Int for value: Int |
| Decimal | Enum Decimal for value: Decimal |
| DateTime | Enum DateTime for value: DateTime |
| Boolean | Enum Boolean for value: Boolean |
| ResultValue | Enum ResultValue for value: ResultValue |
| Result0D | Enum Result0D for value: Result0D |
| Json | Enum Json for value: Json |
◆ TypeEnum
|
strong |
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
| Enumerator | |
|---|---|
| String | Enum String for value: String |
| Int | Enum Int for value: Int |
| Decimal | Enum Decimal for value: Decimal |
| DateTime | Enum DateTime for value: DateTime |
| Boolean | Enum Boolean for value: Boolean |
| ResultValue | Enum ResultValue for value: ResultValue |
| Result0D | Enum Result0D for value: Result0D |
| Json | Enum Json for value: Json |
Constructor & Destructor Documentation
◆ AggregationQuery() [1/2]
|
inlineprotected |
Initializes a new instance of the AggregationQuery class.
◆ AggregationQuery() [2/2]
|
inline |
Initializes a new instance of the AggregationQuery class.
- Parameters
-
addressKey The address that is the query to be made into the system. e.g. a Valuation/PV or Instrument/MaturityDate (required). description What does the information that is being queried by the address mean. What is the address for. (required). displayName The suggested name that the user would wish to put on to the returned information for visualisation in preference to the address. (required). type Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json (required). flattenedType Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json (required). scalesWithHoldingQuantity Is the data scaled when it is for, e.g. a holding in an instrument. A key example would be the difference between price and PV. The present value of an instrument would scale with the quantity held. The price would be that for a hypothetical unit of that instrument, typically associated with the contract size. (required). supportedOperations When performing an aggregation operation, what column type operations can be performed on the data. For example, it makes sense to sum decimals but not strings. Either can be counted. With more complex types, e.g. ResultValues, operations may be linked to a semantic meaning such as the currency of the result. In such cases the operations may be supported but context specific. For example, it makes sense to sum PVs in a single currency but not when the currency is different. In such cases, an error would result (it being assumed that no fx rates for currency conversion were implicit in the context). (required). lifeCycleStatus Within an API where an item can be accessed through an address or property, there is an associated status that determines whether the item is stable or likely to change. This status is one of [Experimental, Beta, EAP, Prod, Deprecated]. If the item is deprecated it will be removed on or after the associated DateTime RemovalDate field. That field will not otherwise be set. (required). removalDate If the life cycle status is set to deprecated then this will be populated with the date on or after which removal of the address query will happen. applicableOptions A mapping from option names to the definition that the corresponding option value must match..
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if AggregationQuery instances are equal
- Parameters
-
input Instance of AggregationQuery to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ AddressKey
|
getset |
The address that is the query to be made into the system. e.g. a Valuation/PV or Instrument/MaturityDate
The address that is the query to be made into the system. e.g. a Valuation/PV or Instrument/MaturityDate
◆ ApplicableOptions
|
getset |
A mapping from option names to the definition that the corresponding option value must match.
A mapping from option names to the definition that the corresponding option value must match.
◆ Description
|
getset |
What does the information that is being queried by the address mean. What is the address for.
What does the information that is being queried by the address mean. What is the address for.
◆ DisplayName
|
getset |
The suggested name that the user would wish to put on to the returned information for visualisation in preference to the address.
The suggested name that the user would wish to put on to the returned information for visualisation in preference to the address.
◆ FlattenedType
|
getset |
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the simpler representation. 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. In this example, the type returned in this field would be "Decimal". The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
◆ LifeCycleStatus
|
getset |
Within an API where an item can be accessed through an address or property, there is an associated status that determines whether the item is stable or likely to change. This status is one of [Experimental, Beta, EAP, Prod, Deprecated]. If the item is deprecated it will be removed on or after the associated DateTime RemovalDate field. That field will not otherwise be set.
Within an API where an item can be accessed through an address or property, there is an associated status that determines whether the item is stable or likely to change. This status is one of [Experimental, Beta, EAP, Prod, Deprecated]. If the item is deprecated it will be removed on or after the associated DateTime RemovalDate field. That field will not otherwise be set.
◆ RemovalDate
|
getset |
If the life cycle status is set to deprecated then this will be populated with the date on or after which removal of the address query will happen
If the life cycle status is set to deprecated then this will be populated with the date on or after which removal of the address query will happen
◆ ScalesWithHoldingQuantity
|
getset |
Is the data scaled when it is for, e.g. a holding in an instrument. A key example would be the difference between price and PV. The present value of an instrument would scale with the quantity held. The price would be that for a hypothetical unit of that instrument, typically associated with the contract size.
Is the data scaled when it is for, e.g. a holding in an instrument. A key example would be the difference between price and PV. The present value of an instrument would scale with the quantity held. The price would be that for a hypothetical unit of that instrument, typically associated with the contract size.
◆ SupportedOperations
|
getset |
When performing an aggregation operation, what column type operations can be performed on the data. For example, it makes sense to sum decimals but not strings. Either can be counted. With more complex types, e.g. ResultValues, operations may be linked to a semantic meaning such as the currency of the result. In such cases the operations may be supported but context specific. For example, it makes sense to sum PVs in a single currency but not when the currency is different. In such cases, an error would result (it being assumed that no fx rates for currency conversion were implicit in the context).
When performing an aggregation operation, what column type operations can be performed on the data. For example, it makes sense to sum decimals but not strings. Either can be counted. With more complex types, e.g. ResultValues, operations may be linked to a semantic meaning such as the currency of the result. In such cases the operations may be supported but context specific. For example, it makes sense to sum PVs in a single currency but not when the currency is different. In such cases, an error would result (it being assumed that no fx rates for currency conversion were implicit in the context).
◆ Type
|
getset |
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
Financially meaningful results can be presented as either simple flat types or more complex expanded types. This field gives the type of the more complex representation. 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. In this example, the type returned in this field would be "Result0D", the decimal-currency pair. The available values are: String, Int, Decimal, DateTime, Boolean, ResultValue, Result0D, Json
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/AggregationQuery.cs
