Attribute

Home > @gooddata/sdk-code-schemas > v1 > Attribute

v1.Attribute interface

Signature:

export interface Attribute 

Properties

Property	Modifiers	Type	Description
data_type		"INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN"	A column data type in the physical database.
default_view?		string	(Optional) An Id of the label to be used by default for this field
description?		string	(Optional) An optional description of the field.
is_hidden?		boolean	(Optional)
is_nullable?		boolean	(Optional) Optional flag to indicate if the attribute can contain null values.
labels?		{ [k: string]: Label; }	(Optional)
locale?		string	(Optional) Locale string in BCP 47 format used for default label sorting.
null_value_join_replacement?		string	(Optional) Optional value which can be used as replacement for NULL in join conditions.
show_in_ai_results?		boolean	(Optional) Optional flag to indicate if the attribute should be shown in AI results. When omitted, the attribute is visible.
sort_column?		string	(Optional) A column name in the source table to do sorting by
sort_direction?		"ASC" | "DESC"	(Optional)
source_column?		string	(Optional) A column name in the physical database. Optional, equals to id by default.
tags?		Tags1	(Optional)
title?		string	(Optional) A human readable title of the field. Optional, derived from id if not provided explicitly.
type		"attribute"