Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSetPropsMixin.AggregateOperationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSetPropsMixin.AggregateOperationProperty.Jsii$Proxy

Enclosing class:

CfnDataSetPropsMixin

@Stability(Stable)
public static interface CfnDataSetPropsMixin.AggregateOperationProperty
extends software.amazon.jsii.JsiiSerializable

A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 AggregateOperationProperty aggregateOperationProperty = AggregateOperationProperty.builder()
         .aggregations(List.of(AggregationProperty.builder()
                 .aggregationFunction(DataPrepAggregationFunctionProperty.builder()
                         .listAggregation(DataPrepListAggregationFunctionProperty.builder()
                                 .distinct(false)
                                 .inputColumnName("inputColumnName")
                                 .separator("separator")
                                 .build())
                         .percentileAggregation(DataPrepPercentileAggregationFunctionProperty.builder()
                                 .inputColumnName("inputColumnName")
                                 .percentileValue(123)
                                 .build())
                         .simpleAggregation(DataPrepSimpleAggregationFunctionProperty.builder()
                                 .functionType("functionType")
                                 .inputColumnName("inputColumnName")
                                 .build())
                         .build())
                 .newColumnId("newColumnId")
                 .newColumnName("newColumnName")
                 .build()))
         .alias("alias")
         .groupByColumnNames(List.of("groupByColumnNames"))
         .source(TransformOperationSourceProperty.builder()
                 .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                         .sourceColumnId("sourceColumnId")
                         .targetColumnId("targetColumnId")
                         .build()))
                 .transformOperationId("transformOperationId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSetPropsMixin.AggregateOperationProperty.Builder	A builder for CfnDataSetPropsMixin.AggregateOperationProperty
static final class	CfnDataSetPropsMixin.AggregateOperationProperty.Jsii$Proxy	An implementation for CfnDataSetPropsMixin.AggregateOperationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSetPropsMixin.AggregateOperationProperty.Builder	builder()
default Object	getAggregations()	The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .
default String	getAlias()	Alias for this operation.
default List<String>	getGroupByColumnNames()	The list of column names to group by when performing the aggregation.
default Object	getSource()	The source transform operation that provides input data for the aggregation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregations

@Stability(Stable)
@Nullable
default Object getAggregations()

The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSetPropsMixin.AggregationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-aggregations

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

Alias for this operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-alias

getGroupByColumnNames

@Stability(Stable)
@Nullable
default List<String> getGroupByColumnNames()

The list of column names to group by when performing the aggregation.

Rows with the same values in these columns will be grouped together.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-groupbycolumnnames

getSource

@Stability(Stable)
@Nullable
default Object getSource()

The source transform operation that provides input data for the aggregation.

Returns union: either IResolvable or CfnDataSetPropsMixin.TransformOperationSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregateoperation.html#cfn-quicksight-dataset-aggregateoperation-source

builder

@Stability(Stable)
static CfnDataSetPropsMixin.AggregateOperationProperty.Builder builder()

Returns:

a CfnDataSetPropsMixin.AggregateOperationProperty.Builder of CfnDataSetPropsMixin.AggregateOperationProperty