Package software.amazon.awssdk.services.cleanrooms.model

Interface AnalysisRuleAggregation.Builder

    • Method Detail

      • aggregateColumns

        AnalysisRuleAggregation.Builder aggregateColumns​(Collection<AggregateColumn> aggregateColumns)

        The columns that query runners are allowed to use in aggregation queries.

        Parameters:
        aggregateColumns - The columns that query runners are allowed to use in aggregation queries.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aggregateColumns

        AnalysisRuleAggregation.Builder aggregateColumns​(AggregateColumn... aggregateColumns)

        The columns that query runners are allowed to use in aggregation queries.

        Parameters:
        aggregateColumns - The columns that query runners are allowed to use in aggregation queries.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • joinColumns

        AnalysisRuleAggregation.Builder joinColumns​(Collection<String> joinColumns)

        Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

        Parameters:
        joinColumns - Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • joinColumns

        AnalysisRuleAggregation.Builder joinColumns​(String... joinColumns)

        Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

        Parameters:
        joinColumns - Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • joinRequired

        AnalysisRuleAggregation.Builder joinRequired​(String joinRequired)

        Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

        Parameters:
        joinRequired - Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JoinRequiredOption, JoinRequiredOption

      • joinRequired

        AnalysisRuleAggregation.Builder joinRequired​(JoinRequiredOption joinRequired)

        Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

        Parameters:
        joinRequired - Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JoinRequiredOption, JoinRequiredOption

      • allowedJoinOperatorsWithStrings

        AnalysisRuleAggregation.Builder allowedJoinOperatorsWithStrings​(Collection<String> allowedJoinOperators)

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

        Parameters:
        allowedJoinOperators - Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowedJoinOperatorsWithStrings

        AnalysisRuleAggregation.Builder allowedJoinOperatorsWithStrings​(String... allowedJoinOperators)

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

        Parameters:
        allowedJoinOperators - Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowedJoinOperators

        AnalysisRuleAggregation.Builder allowedJoinOperators​(Collection<JoinOperator> allowedJoinOperators)

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

        Parameters:
        allowedJoinOperators - Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowedJoinOperators

        AnalysisRuleAggregation.Builder allowedJoinOperators​(JoinOperator... allowedJoinOperators)

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

        Parameters:
        allowedJoinOperators - Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dimensionColumns

        AnalysisRuleAggregation.Builder dimensionColumns​(Collection<String> dimensionColumns)

        The columns that query runners are allowed to select, group by, or filter by.

        Parameters:
        dimensionColumns - The columns that query runners are allowed to select, group by, or filter by.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dimensionColumns

        AnalysisRuleAggregation.Builder dimensionColumns​(String... dimensionColumns)

        The columns that query runners are allowed to select, group by, or filter by.

        Parameters:
        dimensionColumns - The columns that query runners are allowed to select, group by, or filter by.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scalarFunctionsWithStrings

        AnalysisRuleAggregation.Builder scalarFunctionsWithStrings​(Collection<String> scalarFunctions)

        Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        Parameters:
        scalarFunctions - Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scalarFunctionsWithStrings

        AnalysisRuleAggregation.Builder scalarFunctionsWithStrings​(String... scalarFunctions)

        Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        Parameters:
        scalarFunctions - Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scalarFunctions

        AnalysisRuleAggregation.Builder scalarFunctions​(Collection<ScalarFunctions> scalarFunctions)

        Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        Parameters:
        scalarFunctions - Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scalarFunctions

        AnalysisRuleAggregation.Builder scalarFunctions​(ScalarFunctions... scalarFunctions)

        Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        Parameters:
        scalarFunctions - Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputConstraints

        AnalysisRuleAggregation.Builder outputConstraints​(Collection<AggregationConstraint> outputConstraints)

        Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

        Parameters:
        outputConstraints - Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputConstraints

        AnalysisRuleAggregation.Builder outputConstraints​(AggregationConstraint... outputConstraints)

        Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

        Parameters:
        outputConstraints - Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalAnalyses

        AnalysisRuleAggregation.Builder additionalAnalyses​(String additionalAnalyses)

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

        The additionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

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

        The additionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AdditionalAnalyses, AdditionalAnalyses

      • additionalAnalyses

        AnalysisRuleAggregation.Builder additionalAnalyses​(AdditionalAnalyses additionalAnalyses)

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

        The additionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

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

        The additionalAnalyses parameter is currently supported for the list analysis rule ( AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AdditionalAnalyses, AdditionalAnalyses