Skip to content

AnalysisRuleList

Source code in docs_src/capo_cleanrooms/types/analysis_rule_list.py
class AnalysisRuleList(TypedDict, closed=True):
    join_columns: (
        "capo_cleanrooms.types.analysis_rule_column_list.AnalysisRuleColumnList"
    )
    """<p>Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.</p>"""
    allowed_join_operators: NotRequired[
        "capo_cleanrooms.types.join_operators_list.JoinOperatorsList"
    ]
    """<p>The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is <code>AND</code>.</p>"""
    list_columns: (
        "capo_cleanrooms.types.analysis_rule_column_list.AnalysisRuleColumnList"
    )
    """<p>Columns that can be listed in the output.</p>"""
    additional_analyses: NotRequired[
        "capo_cleanrooms.types.additional_analyses.AdditionalAnalyses"
    ]
    """<p> An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.</p>"""

additional_analyses instance-attribute

additional_analyses: NotRequired[AdditionalAnalyses]

An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

allowed_join_operators instance-attribute

allowed_join_operators: NotRequired[JoinOperatorsList]

The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.

join_columns instance-attribute

join_columns: AnalysisRuleColumnList

Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

list_columns instance-attribute

list_columns: AnalysisRuleColumnList

Columns that can be listed in the output.