AtlasEnumDefOutput interface

Package:

@azure-rest/purview-datamap

class that captures details of an enum-type.

Properties

category	The enum of type category. Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE"
createdBy	The user who created the record.
createTime	The created time of the record.
dateFormatter	The date format.
defaultValue	The default value.
description	The description of the type definition.
elementDefs	An array of enum element definitions.
guid	The GUID of the type definition.
lastModifiedTS	ETag for concurrency control.
name	The name of the type definition.
options	The options for the type definition.
serviceType	The service type.
typeVersion	The version of the type.
updatedBy	The user who updated the record.
updateTime	The update time of the record.
version	The version of the record.

Property Details

category

The enum of type category.

Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE"

category?: string

Property Value

string

createdBy

The user who created the record.

createdBy?: string

Property Value

string

createTime

The created time of the record.

createTime?: number

Property Value

number

dateFormatter

The date format.

dateFormatter?: DateFormatOutput

Property Value

DateFormatOutput

defaultValue

The default value.

defaultValue?: string

Property Value

string

description

The description of the type definition.

description?: string

Property Value

string

elementDefs

An array of enum element definitions.

elementDefs?: AtlasEnumElementDefOutput[]

Property Value

AtlasEnumElementDefOutput[]

guid

The GUID of the type definition.

guid?: string

Property Value

string

lastModifiedTS

ETag for concurrency control.

lastModifiedTS?: string

Property Value

string

name

The name of the type definition.

name?: string

Property Value

string

options

The options for the type definition.

options?: Record<string, string>

Property Value

Record<string, string>

serviceType

The service type.

serviceType?: string

Property Value

string

typeVersion

The version of the type.

typeVersion?: string

Property Value

string

updatedBy

The user who updated the record.

updatedBy?: string

Property Value

string

updateTime

The update time of the record.

updateTime?: number

Property Value

number

version

The version of the record.

version?: number

Property Value

number