Skip to content

TypedLinkAttributeDefinition

Source code in docs_src/capo_clouddirectory/types/typed_link_attribute_definition.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class TypedLinkAttributeDefinition(TypedDict, closed=True):
    name: "capo_clouddirectory.types.attribute_name.AttributeName"
    """<p>The unique name of the typed link attribute.</p>"""
    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 that are attached to the attribute definition.</p>"""
    required_behavior: "capo_clouddirectory.types.required_attribute_behavior.RequiredAttributeBehavior"
    """<p>The required behavior of the <code>TypedLinkAttributeDefinition</code>.</p>"""

default_value: NotRequired[TypedAttributeValue]

The default value of the attribute (if configured).

is_immutable: Bool

Whether the attribute is mutable or not.

name: AttributeName

The unique name of the typed link attribute.

required_behavior: RequiredAttributeBehavior

The required behavior of the TypedLinkAttributeDefinition.

rules: NotRequired[RuleMap]

Validation rules that are attached to the attribute definition.

type: FacetAttributeType

The type of the attribute.