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

MetadataFieldDefinition More...

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

Public Member Functions

 MetadataFieldDefinition (string fieldName=default(string), string displayName=default(string), string description=default(string), ResourceId dataTypeId=default(ResourceId))
 Initializes a new instance of the MetadataFieldDefinition 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 (MetadataFieldDefinition input)
 Returns true if MetadataFieldDefinition instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string FieldName [get, set]
 The unique identifier for the metadata field. More...
 
string DisplayName [get, set]
 A user-friendly display name for the metadata field. More...
 
string Description [get, set]
 A detailed description of the metadata field and its purpose. More...
 
ResourceId DataTypeId [get, set]
 Gets or Sets DataTypeId More...
 

Detailed Description

MetadataFieldDefinition

Constructor & Destructor Documentation

◆ MetadataFieldDefinition() [1/2]

Lusid.Sdk.Model.MetadataFieldDefinition.MetadataFieldDefinition ( )
inlineprotected

Initializes a new instance of the MetadataFieldDefinition class.

◆ MetadataFieldDefinition() [2/2]

Lusid.Sdk.Model.MetadataFieldDefinition.MetadataFieldDefinition ( string  fieldName = default(string),
string  displayName = default(string),
string  description = default(string),
ResourceId  dataTypeId = default(ResourceId) 
)
inline

Initializes a new instance of the MetadataFieldDefinition class.

Parameters
fieldNameThe unique identifier for the metadata field. (required).
displayNameA user-friendly display name for the metadata field..
descriptionA detailed description of the metadata field and its purpose..
dataTypeIddataTypeId (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if MetadataFieldDefinition instances are equal

Parameters
inputInstance of MetadataFieldDefinition to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ DataTypeId

ResourceId Lusid.Sdk.Model.MetadataFieldDefinition.DataTypeId
getset

Gets or Sets DataTypeId

◆ Description

string Lusid.Sdk.Model.MetadataFieldDefinition.Description
getset

A detailed description of the metadata field and its purpose.

A detailed description of the metadata field and its purpose.

◆ DisplayName

string Lusid.Sdk.Model.MetadataFieldDefinition.DisplayName
getset

A user-friendly display name for the metadata field.

A user-friendly display name for the metadata field.

◆ FieldName

string Lusid.Sdk.Model.MetadataFieldDefinition.FieldName
getset

The unique identifier for the metadata field.

The unique identifier for the metadata field.


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