Representation of a Relationship between a requested entity with the stated entity as RelatedEntityId More...

Inheritance diagram for Lusid.Sdk.Model.Relationship:

Public Member Functions
	Relationship (ModelVersion version=default(ModelVersion), ResourceId relationshipDefinitionId=default(ResourceId), RelatedEntity relatedEntity=default(RelatedEntity), string traversalDirection=default(string), string traversalDescription=default(string), DateTimeOffset effectiveFrom=default(DateTimeOffset), DateTimeOffset effectiveUntil=default(DateTimeOffset))
	Initializes a new instance of the Relationship 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 (Relationship input)
	Returns true if Relationship instances are equal More...

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

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

Properties
ModelVersion	_Version `[get, set]`
	Gets or Sets _Version More...

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

RelatedEntity	RelatedEntity `[get, set]`
	Gets or Sets RelatedEntity More...

string	TraversalDirection `[get, set]`
	Direction of relationship between the requested entity and related entity. This can be 'In' or 'Out'. Read more about relationships traversal direction in LUSID Knowledge Base here https://support.lusid.com/knowledgebase/article/KA-01679. More...

string	TraversalDescription `[get, set]`
	Description of the relationship based on relationship's traversal direction. If 'TraversalDirection' is 'Out', this description would be 'OutwardDescription' from the associated relationship definition. If 'TraversalDirection' is 'In', this description would be 'InwardDescription' from the associated relationship definition. More...

DateTimeOffset	EffectiveFrom `[get, set]`
	The effective datetime from which the relationship is valid. More...

DateTimeOffset	EffectiveUntil `[get, set]`
	The effective datetime until which the relationship is valid. If no future deletions are present or an effective until has not been set for the relationship, this will be indefinite and represented by the maximum date. More...

Detailed Description

Representation of a Relationship between a requested entity with the stated entity as RelatedEntityId

Constructor & Destructor Documentation

◆ Relationship() [1/2]

Lusid.Sdk.Model.Relationship.Relationship ( )

inlineprotected

Initializes a new instance of the Relationship class.

◆ Relationship() [2/2]

Lusid.Sdk.Model.Relationship.Relationship	(	ModelVersion	version = `default(ModelVersion)`,
		ResourceId	relationshipDefinitionId = `default(ResourceId)`,
		RelatedEntity	relatedEntity = `default(RelatedEntity)`,
		string	traversalDirection = `default(string)`,
		string	traversalDescription = `default(string)`,
		DateTimeOffset	effectiveFrom = `default(DateTimeOffset)`,
		DateTimeOffset	effectiveUntil = `default(DateTimeOffset)`
	)

inline

Initializes a new instance of the Relationship class.

Parameters

version	version.
relationshipDefinitionId	relationshipDefinitionId (required).
relatedEntity	relatedEntity (required).
traversalDirection	Direction of relationship between the requested entity and related entity. This can be 'In' or 'Out'. Read more about relationships traversal direction in LUSID Knowledge Base here https://support.lusid.com/knowledgebase/article/KA-01679. (required).
traversalDescription	Description of the relationship based on relationship's traversal direction. If 'TraversalDirection' is 'Out', this description would be 'OutwardDescription' from the associated relationship definition. If 'TraversalDirection' is 'In', this description would be 'InwardDescription' from the associated relationship definition. (required).
effectiveFrom	The effective datetime from which the relationship is valid..
effectiveUntil	The effective datetime until which the relationship is valid. If no future deletions are present or an effective until has not been set for the relationship, this will be indefinite and represented by the maximum date..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.Relationship.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.Relationship.Equals ( Relationship input )

inline

Returns true if Relationship instances are equal

Parameters

input Instance of Relationship to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.Relationship._Version

getset

Gets or Sets _Version

◆ EffectiveFrom

DateTimeOffset Lusid.Sdk.Model.Relationship.EffectiveFrom

getset

The effective datetime from which the relationship is valid.

◆ EffectiveUntil

DateTimeOffset Lusid.Sdk.Model.Relationship.EffectiveUntil

getset

The effective datetime until which the relationship is valid. If no future deletions are present or an effective until has not been set for the relationship, this will be indefinite and represented by the maximum date.

◆ RelatedEntity

RelatedEntity Lusid.Sdk.Model.Relationship.RelatedEntity

getset

Gets or Sets RelatedEntity

◆ RelationshipDefinitionId

ResourceId Lusid.Sdk.Model.Relationship.RelationshipDefinitionId

getset

Gets or Sets RelationshipDefinitionId

◆ TraversalDescription

string Lusid.Sdk.Model.Relationship.TraversalDescription

getset

Description of the relationship based on relationship's traversal direction. If 'TraversalDirection' is 'Out', this description would be 'OutwardDescription' from the associated relationship definition. If 'TraversalDirection' is 'In', this description would be 'InwardDescription' from the associated relationship definition.

◆ TraversalDirection

string Lusid.Sdk.Model.Relationship.TraversalDirection

getset

Direction of relationship between the requested entity and related entity. This can be 'In' or 'Out'. Read more about relationships traversal direction in LUSID Knowledge Base here https://support.lusid.com/knowledgebase/article/KA-01679.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Relationship() [1/2]

◆ Relationship() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ _Version

◆ EffectiveFrom

◆ EffectiveUntil

◆ RelatedEntity

◆ RelationshipDefinitionId

◆ TraversalDescription

◆ TraversalDirection