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

Representation of a relationship containing details of source and target entities, and both outward and inward descriptions. More...

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

Public Member Functions

 CompleteRelationship (string href=default(string), ModelVersion version=default(ModelVersion), ResourceId relationshipDefinitionId=default(ResourceId), RelatedEntity sourceEntity=default(RelatedEntity), RelatedEntity targetEntity=default(RelatedEntity), string outwardDescription=default(string), string inwardDescription=default(string), DateTimeOffset effectiveFrom=default(DateTimeOffset), DateTimeOffset effectiveUntil=default(DateTimeOffset))
 Initializes a new instance of the CompleteRelationship 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 (CompleteRelationship input)
 Returns true if CompleteRelationship instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 
ResourceId RelationshipDefinitionId [get, set]
 Gets or Sets RelationshipDefinitionId More...
 
RelatedEntity SourceEntity [get, set]
 Gets or Sets SourceEntity More...
 
RelatedEntity TargetEntity [get, set]
 Gets or Sets TargetEntity More...
 
string OutwardDescription [get, set]
 Description of the relationship based on relationship definition's outward description. More...
 
string InwardDescription [get, set]
 Description of the relationship based on relationship definition's inward description. More...
 
DateTimeOffset EffectiveFrom [get, set]
 The effective datetime from which the relationship is valid. More...
 
DateTimeOffset EffectiveUntil [get, set]
 The effective datetime to which the relationship is valid until. More...
 

Detailed Description

Representation of a relationship containing details of source and target entities, and both outward and inward descriptions.

Constructor & Destructor Documentation

◆ CompleteRelationship() [1/2]

Lusid.Sdk.Model.CompleteRelationship.CompleteRelationship ( )
inlineprotected

Initializes a new instance of the CompleteRelationship class.

◆ CompleteRelationship() [2/2]

Lusid.Sdk.Model.CompleteRelationship.CompleteRelationship ( string  href = default(string),
ModelVersion  version = default(ModelVersion),
ResourceId  relationshipDefinitionId = default(ResourceId),
RelatedEntity  sourceEntity = default(RelatedEntity),
RelatedEntity  targetEntity = default(RelatedEntity),
string  outwardDescription = default(string),
string  inwardDescription = default(string),
DateTimeOffset  effectiveFrom = default(DateTimeOffset),
DateTimeOffset  effectiveUntil = default(DateTimeOffset) 
)
inline

Initializes a new instance of the CompleteRelationship class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
versionversion.
relationshipDefinitionIdrelationshipDefinitionId (required).
sourceEntitysourceEntity (required).
targetEntitytargetEntity (required).
outwardDescriptionDescription of the relationship based on relationship definition's outward description. (required).
inwardDescriptionDescription of the relationship based on relationship definition's inward description. (required).
effectiveFromThe effective datetime from which the relationship is valid..
effectiveUntilThe effective datetime to which the relationship is valid until..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CompleteRelationship instances are equal

Parameters
inputInstance of CompleteRelationship to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.CompleteRelationship._Version
getset

Gets or Sets _Version

◆ EffectiveFrom

DateTimeOffset Lusid.Sdk.Model.CompleteRelationship.EffectiveFrom
getset

The effective datetime from which the relationship is valid.

The effective datetime from which the relationship is valid.

◆ EffectiveUntil

DateTimeOffset Lusid.Sdk.Model.CompleteRelationship.EffectiveUntil
getset

The effective datetime to which the relationship is valid until.

The effective datetime to which the relationship is valid until.

◆ Href

string Lusid.Sdk.Model.CompleteRelationship.Href
getset

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

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

◆ InwardDescription

string Lusid.Sdk.Model.CompleteRelationship.InwardDescription
getset

Description of the relationship based on relationship definition's inward description.

Description of the relationship based on relationship definition's inward description.

◆ OutwardDescription

string Lusid.Sdk.Model.CompleteRelationship.OutwardDescription
getset

Description of the relationship based on relationship definition's outward description.

Description of the relationship based on relationship definition's outward description.

◆ RelationshipDefinitionId

ResourceId Lusid.Sdk.Model.CompleteRelationship.RelationshipDefinitionId
getset

Gets or Sets RelationshipDefinitionId

◆ SourceEntity

RelatedEntity Lusid.Sdk.Model.CompleteRelationship.SourceEntity
getset

Gets or Sets SourceEntity

◆ TargetEntity

RelatedEntity Lusid.Sdk.Model.CompleteRelationship.TargetEntity
getset

Gets or Sets TargetEntity


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