Inheritance diagram for Lusid.Sdk.Model.DataTypeSummary:

Public Types
enum class	TypeValueRangeEnum { Open = 1 , Closed = 2 }
	Indicates the range of data acceptable by a data type. The available values are: Open, Closed More...

enum class	ValueTypeEnum { String = 1 , Int = 2 , Decimal = 3 , DateTime = 4 , Boolean = 5 , Map = 6 , List = 7 , PropertyArray = 8 , Percentage = 9 , Code = 10 , Id = 11 , Uri = 12 , CurrencyAndAmount = 13 , TradePrice = 14 , Currency = 15 , MetricValue = 16 , ResourceId = 17 , ResultValue = 18 , CutLocalTime = 19 , DateOrCutLabel = 20 , UnindexedText = 21 }
	The expected type of the values. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText More...

enum class	UnitSchemaEnum { NoUnits = 1 , Basic = 2 , Iso4217Currency = 3 }
	The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency More...

Public Member Functions
	DataTypeSummary (TypeValueRangeEnum typeValueRange=default(TypeValueRangeEnum), ResourceId id=default(ResourceId), string displayName=default(string), string description=default(string), ValueTypeEnum valueType=default(ValueTypeEnum), List< string > acceptableValues=default(List< string >), UnitSchemaEnum? unitSchema=default(UnitSchemaEnum?), List< IUnitDefinitionDto > acceptableUnits=default(List< IUnitDefinitionDto >), ModelVersion version=default(ModelVersion))
	Initializes a new instance of the DataTypeSummary 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 (DataTypeSummary input)
	Returns true if DataTypeSummary instances are equal More...

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

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

Properties
TypeValueRangeEnum	TypeValueRange `[get, set]`
	Indicates the range of data acceptable by a data type. The available values are: Open, Closed More...

ValueTypeEnum	ValueType `[get, set]`
	The expected type of the values. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText More...

UnitSchemaEnum?	UnitSchema `[get, set]`
	The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency More...

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

string	DisplayName `[get, set]`
	The display name of the data type. More...

string	Description `[get, set]`
	The description of the data type. More...

List< string >	AcceptableValues `[get, set]`
	The acceptable set of values for this data type. Only applies to 'open' value type range. More...

List< IUnitDefinitionDto >	AcceptableUnits `[get, set]`
	The definitions of the acceptable units. More...

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

Detailed Description

DataTypeSummary

Member Enumeration Documentation

◆ TypeValueRangeEnum

enum Lusid.Sdk.Model.DataTypeSummary.TypeValueRangeEnum

strong

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

Enumerator
Open	Enum Open for value: Open
Closed	Enum Closed for value: Closed

◆ UnitSchemaEnum

enum Lusid.Sdk.Model.DataTypeSummary.UnitSchemaEnum

strong

The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency

Enumerator
NoUnits	Enum NoUnits for value: NoUnits
Basic	Enum Basic for value: Basic
Iso4217Currency	Enum Iso4217Currency for value: Iso4217Currency

◆ ValueTypeEnum

enum Lusid.Sdk.Model.DataTypeSummary.ValueTypeEnum

strong

The expected type of the values. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText

Enumerator
String	Enum String for value: String
Int	Enum Int for value: Int
Decimal	Enum Decimal for value: Decimal
DateTime	Enum DateTime for value: DateTime
Boolean	Enum Boolean for value: Boolean
Map	Enum Map for value: Map
List	Enum List for value: List
PropertyArray	Enum PropertyArray for value: PropertyArray
Percentage	Enum Percentage for value: Percentage
Code	Enum Code for value: Code
Id	Enum Id for value: Id
Uri	Enum Uri for value: Uri
CurrencyAndAmount	Enum CurrencyAndAmount for value: CurrencyAndAmount
TradePrice	Enum TradePrice for value: TradePrice
Currency	Enum Currency for value: Currency
MetricValue	Enum MetricValue for value: MetricValue
ResourceId	Enum ResourceId for value: ResourceId
ResultValue	Enum ResultValue for value: ResultValue
CutLocalTime	Enum CutLocalTime for value: CutLocalTime
DateOrCutLabel	Enum DateOrCutLabel for value: DateOrCutLabel
UnindexedText	Enum UnindexedText for value: UnindexedText

Constructor & Destructor Documentation

◆ DataTypeSummary() [1/2]

Lusid.Sdk.Model.DataTypeSummary.DataTypeSummary ( )

inlineprotected

Initializes a new instance of the DataTypeSummary class.

◆ DataTypeSummary() [2/2]

Lusid.Sdk.Model.DataTypeSummary.DataTypeSummary	(	TypeValueRangeEnum	typeValueRange = `default(TypeValueRangeEnum)`,
		ResourceId	id = `default(ResourceId)`,
		string	displayName = `default(string)`,
		string	description = `default(string)`,
		ValueTypeEnum	valueType = `default(ValueTypeEnum)`,
		List< string >	acceptableValues = `default(List<string>)`,
		UnitSchemaEnum?	unitSchema = `default(UnitSchemaEnum?)`,
		List< IUnitDefinitionDto >	acceptableUnits = `default(List<IUnitDefinitionDto>)`,
		ModelVersion	version = `default(ModelVersion)`
	)

inline

Initializes a new instance of the DataTypeSummary class.

Parameters

typeValueRange	Indicates the range of data acceptable by a data type. The available values are: Open, Closed (required).
id	id (required).
displayName	The display name of the data type. (required).
description	The description of the data type. (required).
valueType	The expected type of the values. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText (required).
acceptableValues	The acceptable set of values for this data type. Only applies to 'open' value type range..
unitSchema	The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency.
acceptableUnits	The definitions of the acceptable units..
version	version.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.DataTypeSummary.Equals ( DataTypeSummary input )

inline

Returns true if DataTypeSummary instances are equal

Parameters

input Instance of DataTypeSummary to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.DataTypeSummary.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.DataTypeSummary._Version

getset

Gets or Sets _Version

◆ AcceptableUnits

List<IUnitDefinitionDto> Lusid.Sdk.Model.DataTypeSummary.AcceptableUnits

getset

The definitions of the acceptable units.

◆ AcceptableValues

List<string> Lusid.Sdk.Model.DataTypeSummary.AcceptableValues

getset

The acceptable set of values for this data type. Only applies to 'open' value type range.

◆ Description

string Lusid.Sdk.Model.DataTypeSummary.Description

getset

The description of the data type.

◆ DisplayName

string Lusid.Sdk.Model.DataTypeSummary.DisplayName

getset

The display name of the data type.

◆ Id

ResourceId Lusid.Sdk.Model.DataTypeSummary.Id

getset

Gets or Sets Id

◆ TypeValueRange

TypeValueRangeEnum Lusid.Sdk.Model.DataTypeSummary.TypeValueRange

getset

Indicates the range of data acceptable by a data type. The available values are: Open, Closed

◆ UnitSchema

UnitSchemaEnum? Lusid.Sdk.Model.DataTypeSummary.UnitSchema

getset

The schema of the data type's units. The available values are: NoUnits, Basic, Iso4217Currency

◆ ValueType

ValueTypeEnum Lusid.Sdk.Model.DataTypeSummary.ValueType

getset

The expected type of the values. The available values are: String, Int, Decimal, DateTime, Boolean, Map, List, PropertyArray, Percentage, Code, Id, Uri, CurrencyAndAmount, TradePrice, Currency, MetricValue, ResourceId, ResultValue, CutLocalTime, DateOrCutLabel, UnindexedText

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

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ TypeValueRangeEnum

◆ UnitSchemaEnum

◆ ValueTypeEnum

Constructor & Destructor Documentation

◆ DataTypeSummary() [1/2]

◆ DataTypeSummary() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ _Version

◆ AcceptableUnits

◆ AcceptableValues

◆ Description

◆ DisplayName

◆ Id

◆ TypeValueRange

◆ UnitSchema

◆ ValueType