Skip to content

FacetAttributeDefinition

Source code in docs_src/capo_clouddirectory/types/facet_attribute_definition.py 
16
17
18
19
20
21
22
23
24
25
26
class FacetAttributeDefinition(TypedDict, closed=True):
    type: "capo_clouddirectory.types.facet_attribute_type.FacetAttributeType"
    """<p>The type of the attribute.</p>"""
    default_value: NotRequired[
        "capo_clouddirectory.types.typed_attribute_value.TypedAttributeValue"
    ]
    """<p>The default value of the attribute (if configured).</p>"""
    is_immutable: "capo_clouddirectory.types.bool.Bool"
    """<p>Whether the attribute is mutable or not.</p>"""
    rules: NotRequired["capo_clouddirectory.types.rule_map.RuleMap"]
    """<p>Validation rules attached to the attribute definition.</p>"""

default_value instance-attribute 

default_value: NotRequired[TypedAttributeValue]

The default value of the attribute (if configured).

is_immutable instance-attribute 

is_immutable: Bool

Whether the attribute is mutable or not.

rules instance-attribute 

rules: NotRequired[RuleMap]

Validation rules attached to the attribute definition.

type instance-attribute 

type: FacetAttributeType

The type of the attribute.