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

Representation of Custom Entity Definition on LUSID API More...

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

Public Member Functions

 CustomEntityDefinition (string href=default(string), string entityTypeName=default(string), string displayName=default(string), string description=default(string), string entityType=default(string), List< CustomEntityFieldDefinition > fieldSchema=default(List< CustomEntityFieldDefinition >), ModelVersion version=default(ModelVersion))
 Initializes a new instance of the CustomEntityDefinition 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 (CustomEntityDefinition input)
 Returns true if CustomEntityDefinition instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
string EntityTypeName [get, set]
 The name provided when the custom entity type was created. This has been prefixed with “~” and returned as “entityType”, which is the identifier for the custom entity type. More...
 
string DisplayName [get, set]
 A display label for the custom entity type. More...
 
string Description [get, set]
 A description for the custom entity type. More...
 
string EntityType [get, set]
 The identifier for the custom entity type, derived from the “entityTypeName” provided on creation. More...
 
List< CustomEntityFieldDefinitionFieldSchema [get, set]
 The description of the fields on the custom entity type. More...
 
ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 

Detailed Description

Representation of Custom Entity Definition on LUSID API

Constructor & Destructor Documentation

◆ CustomEntityDefinition() [1/2]

Lusid.Sdk.Model.CustomEntityDefinition.CustomEntityDefinition ( )
inlineprotected

Initializes a new instance of the CustomEntityDefinition class.

◆ CustomEntityDefinition() [2/2]

Lusid.Sdk.Model.CustomEntityDefinition.CustomEntityDefinition ( string  href = default(string),
string  entityTypeName = default(string),
string  displayName = default(string),
string  description = default(string),
string  entityType = default(string),
List< CustomEntityFieldDefinition fieldSchema = default(List<CustomEntityFieldDefinition>),
ModelVersion  version = default(ModelVersion) 
)
inline

Initializes a new instance of the CustomEntityDefinition class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
entityTypeNameThe name provided when the custom entity type was created. This has been prefixed with “~” and returned as “entityType”, which is the identifier for the custom entity type. (required).
displayNameA display label for the custom entity type. (required).
descriptionA description for the custom entity type..
entityTypeThe identifier for the custom entity type, derived from the “entityTypeName” provided on creation. (required).
fieldSchemaThe description of the fields on the custom entity type. (required).
versionversion (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CustomEntityDefinition instances are equal

Parameters
inputInstance of CustomEntityDefinition to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.CustomEntityDefinition._Version
getset

Gets or Sets _Version

◆ Description

string Lusid.Sdk.Model.CustomEntityDefinition.Description
getset

A description for the custom entity type.

A description for the custom entity type.

◆ DisplayName

string Lusid.Sdk.Model.CustomEntityDefinition.DisplayName
getset

A display label for the custom entity type.

A display label for the custom entity type.

◆ EntityType

string Lusid.Sdk.Model.CustomEntityDefinition.EntityType
getset

The identifier for the custom entity type, derived from the “entityTypeName” provided on creation.

The identifier for the custom entity type, derived from the “entityTypeName” provided on creation.

◆ EntityTypeName

string Lusid.Sdk.Model.CustomEntityDefinition.EntityTypeName
getset

The name provided when the custom entity type was created. This has been prefixed with “~” and returned as “entityType”, which is the identifier for the custom entity type.

The name provided when the custom entity type was created. This has been prefixed with “~” and returned as “entityType”, which is the identifier for the custom entity type.

◆ FieldSchema

List<CustomEntityFieldDefinition> Lusid.Sdk.Model.CustomEntityDefinition.FieldSchema
getset

The description of the fields on the custom entity type.

The description of the fields on the custom entity type.

◆ Href

string Lusid.Sdk.Model.CustomEntityDefinition.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.


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