LUSID C# SDK
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.CreatePropertyDefinitionRequest Class Reference

CreatePropertyDefinitionRequest More...

Inheritance diagram for Lusid.Sdk.Model.CreatePropertyDefinitionRequest:
Inheritance graph
[legend]

Public Types

enum class  DomainEnum {
  NotDefined = 1 , Transaction = 2 , Portfolio = 3 , Holding = 4 ,
  ReferenceHolding = 5 , TransactionConfiguration = 6 , Instrument = 7 , CutLabelDefinition = 8 ,
  Analytic = 9 , PortfolioGroup = 10 , Person = 11 , AccessMetadata = 12 ,
  Order = 13 , UnitResult = 14 , MarketData = 15 , ConfigurationRecipe = 16 ,
  Allocation = 17 , Calendar = 18 , LegalEntity = 19 , Placement = 20 ,
  Execution = 21 , Block = 22 , Participation = 23 , Package = 24 ,
  OrderInstruction = 25 , NextBestAction = 26 , CustomEntity = 27 , InstrumentEvent = 28 ,
  Account = 29 , ChartOfAccounts = 30 , CustodianAccount = 31 , Abor = 32 ,
  AborConfiguration = 33 , Fund = 34 , Reconciliation = 35 , PropertyDefinition = 36 ,
  Compliance = 37 , DiaryEntry = 38 , Leg = 39 , DerivedValuation = 40
}
 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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation More...
 
enum class  LifeTimeEnum { Perpetual = 1 , TimeVariant = 2 }
 Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant More...
 

Public Member Functions

 CreatePropertyDefinitionRequest (DomainEnum domain=default(DomainEnum), string scope=default(string), string code=default(string), bool valueRequired=default(bool), string displayName=default(string), ResourceId dataTypeId=default(ResourceId), LifeTimeEnum? lifeTime=default(LifeTimeEnum?), string constraintStyle=default(string), string propertyDescription=default(string), string collectionType=default(string))
 Initializes a new instance of the CreatePropertyDefinitionRequest 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 (CreatePropertyDefinitionRequest input)
 Returns true if CreatePropertyDefinitionRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 CreatePropertyDefinitionRequest ()
 Initializes a new instance of the CreatePropertyDefinitionRequest class. More...
 

Properties

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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation More...
 
LifeTimeEnumLifeTime [get, set]
 Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant More...
 
string Scope [get, set]
 The scope that the property exists in. More...
 
string Code [get, set]
 The code of the property. Together with the domain and scope this uniquely identifies the property. More...
 
bool ValueRequired [get, set]
 This field is not implemented and should be disregarded. More...
 
string DisplayName [get, set]
 The display name of the property. More...
 
ResourceId DataTypeId [get, set]
 Gets or Sets DataTypeId More...
 
string ConstraintStyle [get, set]
 Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. Defaults to "Property" if not specified. Valid values for this field are: Property, Collection or Identifier. More...
 
string PropertyDescription [get, set]
 Describes the property More...
 
string CollectionType [get, set]
 Describes whether a collection property should behave as a set or as an array. More...
 

Detailed Description

CreatePropertyDefinitionRequest

Member Enumeration Documentation

◆ DomainEnum

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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation

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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation

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

NextBestAction 

Enum NextBestAction for value: NextBestAction

CustomEntity 

Enum CustomEntity for value: CustomEntity

InstrumentEvent 

Enum InstrumentEvent for value: InstrumentEvent

Account 

Enum Account for value: Account

ChartOfAccounts 

Enum ChartOfAccounts for value: ChartOfAccounts

CustodianAccount 

Enum CustodianAccount for value: CustodianAccount

Abor 

Enum Abor for value: Abor

AborConfiguration 

Enum AborConfiguration for value: AborConfiguration

Fund 

Enum Fund for value: Fund

Reconciliation 

Enum Reconciliation for value: Reconciliation

PropertyDefinition 

Enum PropertyDefinition for value: PropertyDefinition

Compliance 

Enum Compliance for value: Compliance

DiaryEntry 

Enum DiaryEntry for value: DiaryEntry

Leg 

Enum Leg for value: Leg

DerivedValuation 

Enum DerivedValuation for value: DerivedValuation

◆ LifeTimeEnum

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

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

Constructor & Destructor Documentation

◆ CreatePropertyDefinitionRequest() [1/2]

Lusid.Sdk.Model.CreatePropertyDefinitionRequest.CreatePropertyDefinitionRequest ( )
inlineprotected

Initializes a new instance of the CreatePropertyDefinitionRequest class.

◆ CreatePropertyDefinitionRequest() [2/2]

Lusid.Sdk.Model.CreatePropertyDefinitionRequest.CreatePropertyDefinitionRequest ( DomainEnum  domain = default(DomainEnum),
string  scope = default(string),
string  code = default(string),
bool  valueRequired = default(bool),
string  displayName = default(string),
ResourceId  dataTypeId = default(ResourceId),
LifeTimeEnum lifeTime = default(LifeTimeEnum?),
string  constraintStyle = default(string),
string  propertyDescription = default(string),
string  collectionType = default(string) 
)
inline

Initializes a new instance of the CreatePropertyDefinitionRequest class.

Parameters
domainThe 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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation (required).
scopeThe scope that the property exists in. (required).
codeThe code of the property. Together with the domain and scope this uniquely identifies the property. (required).
valueRequiredThis field is not implemented and should be disregarded..
displayNameThe display name of the property. (required).
dataTypeIddataTypeId (required).
lifeTimeDescribes how the property's values can change over time. The available values are: Perpetual, TimeVariant.
constraintStyleDescribes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. Defaults to "Property" if not specified. Valid values for this field are: Property, Collection or Identifier..
propertyDescriptionDescribes the property.
collectionTypeDescribes whether a collection property should behave as a set or as an array..

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.CreatePropertyDefinitionRequest.Equals ( CreatePropertyDefinitionRequest  input)
inline

Returns true if CreatePropertyDefinitionRequest instances are equal

Parameters
inputInstance of CreatePropertyDefinitionRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.CreatePropertyDefinitionRequest.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.CreatePropertyDefinitionRequest.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.Code
getset

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

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

◆ CollectionType

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.CollectionType
getset

Describes whether a collection property should behave as a set or as an array.

Describes whether a collection property should behave as a set or as an array.

◆ ConstraintStyle

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.ConstraintStyle
getset

Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. Defaults to "Property" if not specified. Valid values for this field are: Property, Collection or Identifier.

Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. Defaults to "Property" if not specified. Valid values for this field are: Property, Collection or Identifier.

◆ DataTypeId

ResourceId Lusid.Sdk.Model.CreatePropertyDefinitionRequest.DataTypeId
getset

Gets or Sets DataTypeId

◆ DisplayName

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.DisplayName
getset

The display name of the property.

The display name of the property.

◆ Domain

DomainEnum Lusid.Sdk.Model.CreatePropertyDefinitionRequest.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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation

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, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation

◆ LifeTime

LifeTimeEnum? Lusid.Sdk.Model.CreatePropertyDefinitionRequest.LifeTime
getset

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

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

◆ PropertyDescription

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.PropertyDescription
getset

Describes the property

Describes the property

◆ Scope

string Lusid.Sdk.Model.CreatePropertyDefinitionRequest.Scope
getset

The scope that the property exists in.

The scope that the property exists in.

◆ ValueRequired

bool Lusid.Sdk.Model.CreatePropertyDefinitionRequest.ValueRequired
getset

This field is not implemented and should be disregarded.

This field is not implemented and should be disregarded.


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