Label

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

v1.Label interface

This interface was referenced by undefined's JSON-Schema definition via the patternProperty "^(?!.)[.A-Za-z0-9_-]{1,255}$".

Signature:

export interface Label 

Properties

Property	Modifiers	Type	Description
data_type?		"INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN"	(Optional) A column data type in the physical database.
description?		string	(Optional) An optional description of the label.
geo_area_config?		GeoAreaConfig	(Optional)
is_hidden?		boolean	(Optional)
is_nullable?		boolean	(Optional) Optional flag to indicate if the label can contain null values.
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 label should be shown in AI results. When omitted, the label is visible.
source_column?		string	(Optional) A column name in the physical database.
tags?		Tags2	(Optional)
title?		string	(Optional) An optional human readable title for the label.
translations?		LabelTranslation[]	(Optional) Optional list of localized source columns for this label.
value_type?		"TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_ICON" | "IMAGE" | "GEO_AREA"	(Optional)