A list of property definitions. More...

Inheritance diagram for Lusid.Sdk.Model.PropertyDefinition:

Public Types
enum	ValueTypeEnum { ValueTypeEnum.String = 1, ValueTypeEnum.Int = 2, ValueTypeEnum.Decimal = 3, ValueTypeEnum.DateTime = 4, ValueTypeEnum.Boolean = 5, ValueTypeEnum.Map = 6, ValueTypeEnum.List = 7, ValueTypeEnum.PropertyArray = 8, ValueTypeEnum.Percentage = 9, ValueTypeEnum.Code = 10, ValueTypeEnum.Id = 11, ValueTypeEnum.Uri = 12, ValueTypeEnum.CurrencyAndAmount = 13, ValueTypeEnum.TradePrice = 14, ValueTypeEnum.Currency = 15, ValueTypeEnum.MetricValue = 16, ValueTypeEnum.ResourceId = 17, ValueTypeEnum.ResultValue = 18, ValueTypeEnum.CutLocalTime = 19, ValueTypeEnum.DateOrCutLabel = 20 }
	The type of values that can be associated with this property. This is defined by the property's data type. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel More...

enum	TypeEnum { TypeEnum.Label = 1, TypeEnum.Metric = 2, TypeEnum.Information = 3 }
	The type of the property. The available values are: Label, Metric, Information More...

enum	UnitSchemaEnum { UnitSchemaEnum.NoUnits = 1, UnitSchemaEnum.Basic = 2, UnitSchemaEnum.Iso4217Currency = 3 }
	The units that can be associated with the property's values. This is defined by the property's data type. The available values are: NoUnits, Basic, Iso4217Currency More...

enum	DomainEnum { DomainEnum.NotDefined = 1, DomainEnum.Transaction = 2, DomainEnum.Portfolio = 3, DomainEnum.Holding = 4, DomainEnum.ReferenceHolding = 5, DomainEnum.TransactionConfiguration = 6, DomainEnum.Instrument = 7, DomainEnum.CutLabelDefinition = 8, DomainEnum.Analytic = 9, DomainEnum.PortfolioGroup = 10, DomainEnum.Person = 11, DomainEnum.AccessMetadata = 12, DomainEnum.Order = 13, DomainEnum.UnitResult = 14, DomainEnum.MarketData = 15, DomainEnum.ConfigurationRecipe = 16, DomainEnum.Allocation = 17, DomainEnum.Calendar = 18, DomainEnum.LegalEntity = 19, DomainEnum.Placement = 20, DomainEnum.Execution = 21, DomainEnum.Block = 22, DomainEnum.Participation = 23, DomainEnum.Package = 24, DomainEnum.OrderInstruction = 25 }
	The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction More...

enum	LifeTimeEnum { LifeTimeEnum.Perpetual = 1, LifeTimeEnum.TimeVariant = 2 }
	Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant More...

enum	PropertyDefinitionTypeEnum { PropertyDefinitionTypeEnum.ValueProperty = 1, PropertyDefinitionTypeEnum.DerivedDefinition = 2 }
	The definition type (DerivedDefinition or Definition). The available values are: ValueProperty, DerivedDefinition More...

Public Member Functions
	PropertyDefinition (string href=default(string), string key=default(string), ValueTypeEnum? valueType=default(ValueTypeEnum?), string displayName=default(string), ResourceId dataTypeId=default(ResourceId), TypeEnum? type=default(TypeEnum?), UnitSchemaEnum? unitSchema=default(UnitSchemaEnum?), DomainEnum? domain=default(DomainEnum?), bool valueRequired=default(bool), LifeTimeEnum? lifeTime=default(LifeTimeEnum?), string constraintStyle=default(string), PropertyDefinitionTypeEnum? propertyDefinitionType=default(PropertyDefinitionTypeEnum?), string propertyDescription=default(string), string derivationFormula=default(string), List< Link > links=default(List< Link >))
	Initializes a new instance of the PropertyDefinition class. More...

bool	ShouldSerializeScope ()
	Returns false as Scope should not be serialized given that it's read-only. More...

bool	ShouldSerializeCode ()
	Returns false as Code should not be serialized given that it's read-only. 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 (PropertyDefinition input)
	Returns true if PropertyDefinition instances are equal More...

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

Properties
ValueTypeEnum	ValueType `[get, set]`
	The type of values that can be associated with this property. This is defined by the property's data type. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel More...

TypeEnum	Type `[get, set]`
	The type of the property. The available values are: Label, Metric, Information More...

UnitSchemaEnum	UnitSchema `[get, set]`
	The units that can be associated with the property's values. This is defined by the property's data type. The available values are: NoUnits, Basic, Iso4217Currency More...

DomainEnum	Domain `[get, set]`
	The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction More...

LifeTimeEnum	LifeTime `[get, set]`
	Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant More...

PropertyDefinitionTypeEnum	PropertyDefinitionType `[get, set]`
	The definition type (DerivedDefinition or Definition). The available values are: ValueProperty, DerivedDefinition More...

string	Href `[get, set]`
	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...

string	Key `[get, set]`
	The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'. More...

string	DisplayName `[get, set]`
	The display name of the property. More...

ResourceId	DataTypeId `[get, set]`
	Gets or Sets DataTypeId More...

string	Scope `[get]`
	The scope that the property exists in. More...

string	Code `[get]`
	The code of the property. Together with the domain and scope this uniquely identifies the property. More...

bool	ValueRequired `[get, set]`
	Whether or not a value is always required for this property. More...

string	ConstraintStyle `[get, set]`
	Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. More...

string	PropertyDescription `[get, set]`
	A brief description of what a property of this property definition contains. More...

string	DerivationFormula `[get, set]`
	The rule that defines how data is composed for a derived property. More...

List< Link >	Links `[get, set]`
	Collection of links. More...

Detailed Description

A list of property definitions.

Member Enumeration Documentation

◆ DomainEnum

enum Lusid.Sdk.Model.PropertyDefinition.DomainEnum

strong

The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction

Enumerator
NotDefined	Enum NotDefined for value: NotDefined
Transaction	Enum Transaction for value: Transaction
Portfolio	Enum Portfolio for value: Portfolio
Holding	Enum Holding for value: Holding
ReferenceHolding	Enum ReferenceHolding for value: ReferenceHolding
TransactionConfiguration	Enum TransactionConfiguration for value: TransactionConfiguration
Instrument	Enum Instrument for value: Instrument
CutLabelDefinition	Enum CutLabelDefinition for value: CutLabelDefinition
Analytic	Enum Analytic for value: Analytic
PortfolioGroup	Enum PortfolioGroup for value: PortfolioGroup
Person	Enum Person for value: Person
AccessMetadata	Enum AccessMetadata for value: AccessMetadata
Order	Enum Order for value: Order
UnitResult	Enum UnitResult for value: UnitResult
MarketData	Enum MarketData for value: MarketData
ConfigurationRecipe	Enum ConfigurationRecipe for value: ConfigurationRecipe
Allocation	Enum Allocation for value: Allocation
Calendar	Enum Calendar for value: Calendar
LegalEntity	Enum LegalEntity for value: LegalEntity
Placement	Enum Placement for value: Placement
Execution	Enum Execution for value: Execution
Block	Enum Block for value: Block
Participation	Enum Participation for value: Participation
Package	Enum Package for value: Package
OrderInstruction	Enum OrderInstruction for value: OrderInstruction

◆ LifeTimeEnum

enum Lusid.Sdk.Model.PropertyDefinition.LifeTimeEnum

strong

Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant

Enumerator
Perpetual	Enum Perpetual for value: Perpetual
TimeVariant	Enum TimeVariant for value: TimeVariant

◆ PropertyDefinitionTypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.PropertyDefinitionTypeEnum

strong

The definition type (DerivedDefinition or Definition). The available values are: ValueProperty, DerivedDefinition

Enumerator
ValueProperty	Enum ValueProperty for value: ValueProperty
DerivedDefinition	Enum DerivedDefinition for value: DerivedDefinition

◆ TypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.TypeEnum

strong

The type of the property. The available values are: Label, Metric, Information

Enumerator
Label	Enum Label for value: Label
Metric	Enum Metric for value: Metric
Information	Enum Information for value: Information

◆ UnitSchemaEnum

enum Lusid.Sdk.Model.PropertyDefinition.UnitSchemaEnum

strong

The units that can be associated with the property's values. This is defined by the property's data type. The available values are: NoUnits, Basic, Iso4217Currency

Enumerator
NoUnits	Enum NoUnits for value: NoUnits
Basic	Enum Basic for value: Basic
Iso4217Currency	Enum Iso4217Currency for value: Iso4217Currency

◆ ValueTypeEnum

enum Lusid.Sdk.Model.PropertyDefinition.ValueTypeEnum

strong

The type of values that can be associated with this property. This is defined by the property's data type. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel

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
Map	Enum Map for value: Map
List	Enum List for value: List
PropertyArray	Enum PropertyArray for value: PropertyArray
Percentage	Enum Percentage for value: Percentage
Code	Enum Code for value: Code
Id	Enum Id for value: Id
Uri	Enum Uri for value: Uri
CurrencyAndAmount	Enum CurrencyAndAmount for value: CurrencyAndAmount
TradePrice	Enum TradePrice for value: TradePrice
Currency	Enum Currency for value: Currency
MetricValue	Enum MetricValue for value: MetricValue
ResourceId	Enum ResourceId for value: ResourceId
ResultValue	Enum ResultValue for value: ResultValue
CutLocalTime	Enum CutLocalTime for value: CutLocalTime
DateOrCutLabel	Enum DateOrCutLabel for value: DateOrCutLabel

Constructor & Destructor Documentation

◆ PropertyDefinition()

Lusid.Sdk.Model.PropertyDefinition.PropertyDefinition	(	string	href = `default(string)`,
		string	key = `default(string)`,
		ValueTypeEnum?	valueType = `default(ValueTypeEnum?)`,
		string	displayName = `default(string)`,
		ResourceId	dataTypeId = `default(ResourceId)`,
		TypeEnum?	type = `default(TypeEnum?)`,
		UnitSchemaEnum?	unitSchema = `default(UnitSchemaEnum?)`,
		DomainEnum?	domain = `default(DomainEnum?)`,
		bool	valueRequired = `default(bool)`,
		LifeTimeEnum?	lifeTime = `default(LifeTimeEnum?)`,
		string	constraintStyle = `default(string)`,
		PropertyDefinitionTypeEnum?	propertyDefinitionType = `default(PropertyDefinitionTypeEnum?)`,
		string	propertyDescription = `default(string)`,
		string	derivationFormula = `default(string)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the PropertyDefinition class.

Parameters

href	The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
key	The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'..
valueType	The type of values that can be associated with this property. This is defined by the property's data type. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel.
displayName	The display name of the property..
dataTypeId	dataTypeId.
type	The type of the property. The available values are: Label, Metric, Information.
unitSchema	The units that can be associated with the property's values. This is defined by the property's data type. The available values are: NoUnits, Basic, Iso4217Currency.
domain	The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction.
valueRequired	Whether or not a value is always required for this property..
lifeTime	Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant.
constraintStyle	Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key..
propertyDefinitionType	The definition type (DerivedDefinition or Definition). The available values are: ValueProperty, DerivedDefinition.
propertyDescription	A brief description of what a property of this property definition contains..
derivationFormula	The rule that defines how data is composed for a derived property..
links	Collection of links..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if PropertyDefinition instances are equal

Parameters

input Instance of PropertyDefinition to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ShouldSerializeCode()

bool Lusid.Sdk.Model.PropertyDefinition.ShouldSerializeCode ( )

inline

Returns false as Code should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ShouldSerializeScope()

bool Lusid.Sdk.Model.PropertyDefinition.ShouldSerializeScope ( )

inline

Returns false as Scope should not be serialized given that it's read-only.

Returns: false (boolean)

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.PropertyDefinition.Code

get

The code of the property. Together with the domain and scope this uniquely identifies the property.

◆ ConstraintStyle

string Lusid.Sdk.Model.PropertyDefinition.ConstraintStyle

getset

Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key.

◆ DataTypeId

ResourceId Lusid.Sdk.Model.PropertyDefinition.DataTypeId

getset

Gets or Sets DataTypeId

◆ DerivationFormula

string Lusid.Sdk.Model.PropertyDefinition.DerivationFormula

getset

The rule that defines how data is composed for a derived property.

◆ DisplayName

string Lusid.Sdk.Model.PropertyDefinition.DisplayName

getset

The display name of the property.

◆ Domain

DomainEnum Lusid.Sdk.Model.PropertyDefinition.Domain

getset

The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction

◆ Href

string Lusid.Sdk.Model.PropertyDefinition.Href

getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ Key

string Lusid.Sdk.Model.PropertyDefinition.Key

getset

The property key which uniquely identifies the property. The format for the property key is {domain}/{scope}/{code}, e.g. 'Portfolio/Manager/Id'.

◆ LifeTime

LifeTimeEnum Lusid.Sdk.Model.PropertyDefinition.LifeTime

getset

Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant

◆ Links

List<Link> Lusid.Sdk.Model.PropertyDefinition.Links

getset

Collection of links.

◆ PropertyDefinitionType

PropertyDefinitionTypeEnum Lusid.Sdk.Model.PropertyDefinition.PropertyDefinitionType

getset

The definition type (DerivedDefinition or Definition). The available values are: ValueProperty, DerivedDefinition

◆ PropertyDescription

string Lusid.Sdk.Model.PropertyDefinition.PropertyDescription

getset

A brief description of what a property of this property definition contains.

◆ Scope

string Lusid.Sdk.Model.PropertyDefinition.Scope

get

The scope that the property exists in.

◆ Type

TypeEnum Lusid.Sdk.Model.PropertyDefinition.Type

getset

The type of the property. The available values are: Label, Metric, Information

◆ UnitSchema

UnitSchemaEnum Lusid.Sdk.Model.PropertyDefinition.UnitSchema

getset

The units that can be associated with the property's values. This is defined by the property's data type. The available values are: NoUnits, Basic, Iso4217Currency

◆ ValueRequired

bool Lusid.Sdk.Model.PropertyDefinition.ValueRequired

getset

Whether or not a value is always required for this property.

◆ ValueType

ValueTypeEnum Lusid.Sdk.Model.PropertyDefinition.ValueType

getset

The type of values that can be associated with this property. This is defined by the property's data type. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Model/PropertyDefinition.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ DomainEnum

◆ LifeTimeEnum

◆ PropertyDefinitionTypeEnum

◆ TypeEnum

◆ UnitSchemaEnum

◆ ValueTypeEnum

Constructor & Destructor Documentation

◆ PropertyDefinition()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ShouldSerializeCode()

◆ ShouldSerializeScope()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Code

◆ ConstraintStyle

◆ DataTypeId

◆ DerivationFormula

◆ DisplayName

◆ Domain

◆ Href

◆ Key

◆ LifeTime

◆ Links

◆ PropertyDefinitionType

◆ PropertyDescription

◆ Scope

◆ Type

◆ UnitSchema

◆ ValueRequired

◆ ValueType