Skip to content

NamedEntityDefinition

Source code in docs_src/capo_quicksight/types/named_entity_definition.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class NamedEntityDefinition(TypedDict, closed=True):
    field_name: NotRequired["capo_quicksight.types.limited_string.LimitedString"]
    """<p>The name of the entity.</p>"""
    property_name: NotRequired["capo_quicksight.types.limited_string.LimitedString"]
    """<p>The property name to be used for the named entity.</p>"""
    property_role: NotRequired["capo_quicksight.types.property_role.PropertyRole"]
    """<p>The property role. Valid values for this structure are <code>PRIMARY</code> and <code>ID</code>.</p>"""
    property_usage: NotRequired["capo_quicksight.types.property_usage.PropertyUsage"]
    """<p>The property usage. Valid values for this structure are <code>INHERIT</code>, <code>DIMENSION</code>, and <code>MEASURE</code>.</p>"""
    metric: NotRequired[
        "capo_quicksight.types.named_entity_definition_metric.NamedEntityDefinitionMetric"
    ]
    """<p>The definition of a metric.</p>"""
    rank_order: NotRequired["capo_quicksight.types.nullable_integer.NullableInteger"]
    """<p>The rank order of the named entity definition.</p>"""
    presentation_order: NotRequired[
        "capo_quicksight.types.nullable_integer.NullableInteger"
    ]
    """<p>The presentation order of the named entity definition.</p>"""
    is_hidden: NotRequired["capo_quicksight.types.nullable_boolean.NullableBoolean"]
    """<p>A Boolean value that indicates whether the named entity definition is hidden.</p>"""

field_name instance-attribute 

field_name: NotRequired[LimitedString]

The name of the entity.

is_hidden instance-attribute 

is_hidden: NotRequired[NullableBoolean]

A Boolean value that indicates whether the named entity definition is hidden.

metric instance-attribute 

metric: NotRequired[NamedEntityDefinitionMetric]

The definition of a metric.

presentation_order instance-attribute 

presentation_order: NotRequired[NullableInteger]

The presentation order of the named entity definition.

property_name instance-attribute 

property_name: NotRequired[LimitedString]

The property name to be used for the named entity.

property_role instance-attribute 

property_role: NotRequired[PropertyRole]

The property role. Valid values for this structure are PRIMARY and ID.

property_usage instance-attribute 

property_usage: NotRequired[PropertyUsage]

The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

rank_order instance-attribute 

rank_order: NotRequired[NullableInteger]

The rank order of the named entity definition.