CreateRelationshipDefinitionRequest More...

Inheritance diagram for Lusid.Sdk.Model.CreateRelationshipDefinitionRequest:

Public Member Functions
	CreateRelationshipDefinitionRequest (string scope=default(string), string code=default(string), string sourceEntityType=default(string), string targetEntityType=default(string), string displayName=default(string), string outwardDescription=default(string), string inwardDescription=default(string), string lifeTime=default(string), string relationshipCardinality=default(string))
	Initializes a new instance of the CreateRelationshipDefinitionRequest 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 (CreateRelationshipDefinitionRequest input)
	Returns true if CreateRelationshipDefinitionRequest instances are equal More...

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

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

Properties
string	Scope `[get, set]`
	The scope that the relationship definition exists in. More...

string	Code `[get, set]`
	The code of the relationship definition. Together with the scope this uniquely defines the relationship definition. More...

string	SourceEntityType `[get, set]`
	The entity type of the source entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'. More...

string	TargetEntityType `[get, set]`
	The entity type of the target entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'. More...

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

string	OutwardDescription `[get, set]`
	The description to relate source entity object and target entity object. More...

string	InwardDescription `[get, set]`
	The description to relate target entity object and source entity object. More...

string	LifeTime `[get, set]`
	Describes how the relationships can change over time. Default value: Perpetual. Available values: Perpetual, TimeVariant. More...

string	RelationshipCardinality `[get, set]`
	Describes the cardinality of the relationship with a specific source entity object and relationships under this definition. Default value: ManyToMany. Available values: ManyToOne, ManyToMany. More...

Detailed Description

CreateRelationshipDefinitionRequest

Constructor & Destructor Documentation

◆ CreateRelationshipDefinitionRequest() [1/2]

Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.CreateRelationshipDefinitionRequest ( )

inlineprotected

Initializes a new instance of the CreateRelationshipDefinitionRequest class.

◆ CreateRelationshipDefinitionRequest() [2/2]

Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.CreateRelationshipDefinitionRequest	(	string	scope = `default(string)`,
		string	code = `default(string)`,
		string	sourceEntityType = `default(string)`,
		string	targetEntityType = `default(string)`,
		string	displayName = `default(string)`,
		string	outwardDescription = `default(string)`,
		string	inwardDescription = `default(string)`,
		string	lifeTime = `default(string)`,
		string	relationshipCardinality = `default(string)`
	)

inline

Initializes a new instance of the CreateRelationshipDefinitionRequest class.

Parameters

scope	The scope that the relationship definition exists in. (required).
code	The code of the relationship definition. Together with the scope this uniquely defines the relationship definition. (required).
sourceEntityType	The entity type of the source entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'. (required).
targetEntityType	The entity type of the target entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'. (required).
displayName	The display name of the relationship definition. (required).
outwardDescription	The description to relate source entity object and target entity object. (required).
inwardDescription	The description to relate target entity object and source entity object. (required).
lifeTime	Describes how the relationships can change over time. Default value: Perpetual. Available values: Perpetual, TimeVariant..
relationshipCardinality	Describes the cardinality of the relationship with a specific source entity object and relationships under this definition. Default value: ManyToMany. Available values: ManyToOne, ManyToMany..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if CreateRelationshipDefinitionRequest instances are equal

Parameters

input Instance of CreateRelationshipDefinitionRequest to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Code

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.Code

getset

The code of the relationship definition. Together with the scope this uniquely defines the relationship definition.

◆ DisplayName

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.DisplayName

getset

The display name of the relationship definition.

◆ InwardDescription

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.InwardDescription

getset

The description to relate target entity object and source entity object.

◆ LifeTime

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.LifeTime

getset

Describes how the relationships can change over time. Default value: Perpetual. Available values: Perpetual, TimeVariant.

◆ OutwardDescription

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.OutwardDescription

getset

The description to relate source entity object and target entity object.

◆ RelationshipCardinality

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.RelationshipCardinality

getset

Describes the cardinality of the relationship with a specific source entity object and relationships under this definition. Default value: ManyToMany. Available values: ManyToOne, ManyToMany.

◆ Scope

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.Scope

getset

The scope that the relationship definition exists in.

◆ SourceEntityType

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.SourceEntityType

getset

The entity type of the source entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'.

◆ TargetEntityType

string Lusid.Sdk.Model.CreateRelationshipDefinitionRequest.TargetEntityType

getset

The entity type of the target entity object. Allowed values are 'Portfolio', 'PortfolioGroup', 'Person', 'LegalEntity', 'Instrument' or a custom entity type prefixed with '~'.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CreateRelationshipDefinitionRequest() [1/2]

◆ CreateRelationshipDefinitionRequest() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Code

◆ DisplayName

◆ InwardDescription

◆ LifeTime

◆ OutwardDescription

◆ RelationshipCardinality

◆ Scope

◆ SourceEntityType

◆ TargetEntityType