Lusid.Sdk.Model.RelationalDatasetFieldDefinition Class Reference

RelationalDatasetFieldDefinition More...

Inheritance diagram for Lusid.Sdk.Model.RelationalDatasetFieldDefinition:

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

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

Properties
string	FieldName [get, set]
	The unique identifier for the field within the dataset. More...
string	DisplayName [get, set]
	A user-friendly display name for the field. More...
string	Description [get, set]
	A detailed description of the field and its purpose. More...
ResourceId	DataTypeId [get, set]
	Gets or Sets DataTypeId More...
bool	Required [get, set]
	Whether this field is mandatory in the dataset. More...
string	Category [get, set]
	The intended category of the field (SeriesIdentifier, Value, or Metadata). Available values: SeriesIdentifier, Value, Metadata. More...

Detailed Description

RelationalDatasetFieldDefinition

Constructor & Destructor Documentation

RelationalDatasetFieldDefinition() [1/2]

Lusid.Sdk.Model.RelationalDatasetFieldDefinition.RelationalDatasetFieldDefinition ( )

inlineprotected

Initializes a new instance of the RelationalDatasetFieldDefinition class.

RelationalDatasetFieldDefinition() [2/2]

Lusid.Sdk.Model.RelationalDatasetFieldDefinition.RelationalDatasetFieldDefinition ( string  fieldName = default(string), string  displayName = default(string), string  description = default(string), ResourceId  dataTypeId = default(ResourceId), bool  required = default(bool), string  category = default(string)  )

inline

Initializes a new instance of the RelationalDatasetFieldDefinition class.

Parameters

fieldName	The unique identifier for the field within the dataset. (required).
displayName	A user-friendly display name for the field..
description	A detailed description of the field and its purpose..
dataTypeId	dataTypeId (required).
required	Whether this field is mandatory in the dataset..
category	The intended category of the field (SeriesIdentifier, Value, or Metadata). Available values: SeriesIdentifier, Value, Metadata. (required).

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if RelationalDatasetFieldDefinition instances are equal

Parameters

input

Instance of RelationalDatasetFieldDefinition to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

Category

string Lusid.Sdk.Model.RelationalDatasetFieldDefinition.Category

getset

The intended category of the field (SeriesIdentifier, Value, or Metadata). Available values: SeriesIdentifier, Value, Metadata.

The intended category of the field (SeriesIdentifier, Value, or Metadata). Available values: SeriesIdentifier, Value, Metadata.

DataTypeId

ResourceId Lusid.Sdk.Model.RelationalDatasetFieldDefinition.DataTypeId

getset

Gets or Sets DataTypeId

Description

string Lusid.Sdk.Model.RelationalDatasetFieldDefinition.Description

getset

A detailed description of the field and its purpose.

A detailed description of the field and its purpose.

DisplayName

string Lusid.Sdk.Model.RelationalDatasetFieldDefinition.DisplayName

getset

A user-friendly display name for the field.

A user-friendly display name for the field.

FieldName

string Lusid.Sdk.Model.RelationalDatasetFieldDefinition.FieldName

getset

The unique identifier for the field within the dataset.

The unique identifier for the field within the dataset.

Required

bool Lusid.Sdk.Model.RelationalDatasetFieldDefinition.Required

getset

Whether this field is mandatory in the dataset.

Whether this field is mandatory in the dataset.

---

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