Skip to content

CodegenGenericDataRelationshipType

Source code in docs_src/capo_amplifyuibuilder/types/codegen_generic_data_relationship_type.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class CodegenGenericDataRelationshipType(TypedDict, closed=True):
    type: "capo_amplifyuibuilder.types.generic_data_relationship_type.GenericDataRelationshipType"
    """<p>The data relationship type.</p>"""
    related_model_name: "str"
    """<p>The name of the related model in the data relationship.</p>"""
    related_model_fields: NotRequired[
        "capo_amplifyuibuilder.types.related_model_fields_list.RelatedModelFieldsList"
    ]
    """<p>The related model fields in the data relationship.</p>"""
    can_unlink_associated_model: NotRequired["bool"]
    """<p>Specifies whether the relationship can unlink the associated model.</p>"""
    related_join_field_name: NotRequired["str"]
    """<p>The name of the related join field in the data relationship.</p>"""
    related_join_table_name: NotRequired["str"]
    """<p>The name of the related join table in the data relationship.</p>"""
    belongs_to_field_on_related_model: NotRequired["str"]
    """<p>The value of the <code>belongsTo</code> field on the related data model. </p>"""
    associated_fields: NotRequired[
        "capo_amplifyuibuilder.types.associated_fields_list.AssociatedFieldsList"
    ]
    """<p>The associated fields of the data relationship.</p>"""
    is_has_many_index: NotRequired["bool"]
    """<p>Specifies whether the <code>@index</code> directive is supported for a <code>hasMany</code> data relationship.</p>"""

associated_fields instance-attribute 

associated_fields: NotRequired[AssociatedFieldsList]

The associated fields of the data relationship.

belongs_to_field_on_related_model: NotRequired[str]

The value of the belongsTo field on the related data model. 

can_unlink_associated_model: NotRequired[bool]

Specifies whether the relationship can unlink the associated model.

is_has_many_index instance-attribute 

is_has_many_index: NotRequired[bool]

Specifies whether the @index directive is supported for a hasMany data relationship.

related_join_field_name instance-attribute 

related_join_field_name: NotRequired[str]

The name of the related join field in the data relationship.

related_join_table_name instance-attribute 

related_join_table_name: NotRequired[str]

The name of the related join table in the data relationship.

related_model_fields instance-attribute 

related_model_fields: NotRequired[RelatedModelFieldsList]

The related model fields in the data relationship.

related_model_name instance-attribute 

related_model_name: str

The name of the related model in the data relationship.

type instance-attribute 

type: GenericDataRelationshipType

The data relationship type.