Skip to content

TypedLinkFacet

Source code in docs_src/capo_clouddirectory/types/typed_link_facet.py
class TypedLinkFacet(TypedDict, closed=True):
    name: "capo_clouddirectory.types.typed_link_name.TypedLinkName"
    """<p>The unique name of the typed link facet.</p>"""
    attributes: "capo_clouddirectory.types.typed_link_attribute_definition_list.TypedLinkAttributeDefinitionList"
    """<p>A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.</p>"""
    identity_attribute_order: (
        "capo_clouddirectory.types.attribute_name_list.AttributeNameList"
    )
    """<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>"""

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

identity_attribute_order: AttributeNameList

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

The unique name of the typed link facet.