AtlasAttributeDefOutput interface

Package:

@azure-rest/purview-datamap

class that captures details of a struct-attribute.

Properties

cardinality	single-valued attribute or multi-valued attribute. Possible values: "SINGLE", "LIST", "SET"
constraints	An array of constraints.
defaultValue	The default value of the attribute.
description	The description of the attribute.
includeInNotification	Determines if it is included in notification.
isIndexable	Determines if it is indexable.
isOptional	Determines if it is optional.
isUnique	Determines if it unique.
name	The name of the attribute.
options	The options for the attribute.
typeName	The name of the type.
valuesMaxCount	The maximum count of the values.
valuesMinCount	The minimum count of the values.

Property Details

cardinality

single-valued attribute or multi-valued attribute.

Possible values: "SINGLE", "LIST", "SET"

cardinality?: string

Property Value

string

constraints

An array of constraints.

constraints?: AtlasConstraintDefOutput[]

Property Value

AtlasConstraintDefOutput[]

defaultValue

The default value of the attribute.

defaultValue?: string

Property Value

string

description

The description of the attribute.

description?: string

Property Value

string

includeInNotification

Determines if it is included in notification.

includeInNotification?: boolean

Property Value

boolean

isIndexable

Determines if it is indexable.

isIndexable?: boolean

Property Value

boolean

isOptional

Determines if it is optional.

isOptional?: boolean

Property Value

boolean

isUnique

Determines if it unique.

isUnique?: boolean

Property Value

boolean

name

The name of the attribute.

name?: string

Property Value

string

options

The options for the attribute.

options?: Record<string, string>

Property Value

Record<string, string>

typeName

The name of the type.

typeName?: string

Property Value

string

valuesMaxCount

The maximum count of the values.

valuesMaxCount?: number

Property Value

number

valuesMinCount

The minimum count of the values.

valuesMinCount?: number

Property Value

number