Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.AggregateOperationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.AggregateOperationProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.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.services.quicksight.*;
 AggregateOperationProperty aggregateOperationProperty = AggregateOperationProperty.builder()
         .aggregations(List.of(AggregationProperty.builder()
                 .aggregationFunction(DataPrepAggregationFunctionProperty.builder()
                         .listAggregation(DataPrepListAggregationFunctionProperty.builder()
                                 .distinct(false)
                                 .separator("separator")
                                 // the properties below are optional
                                 .inputColumnName("inputColumnName")
                                 .build())
                         .percentileAggregation(DataPrepPercentileAggregationFunctionProperty.builder()
                                 .percentileValue(123)
                                 // the properties below are optional
                                 .inputColumnName("inputColumnName")
                                 .build())
                         .simpleAggregation(DataPrepSimpleAggregationFunctionProperty.builder()
                                 .functionType("functionType")
                                 // the properties below are optional
                                 .inputColumnName("inputColumnName")
                                 .build())
                         .build())
                 .newColumnId("newColumnId")
                 .newColumnName("newColumnName")
                 .build()))
         .alias("alias")
         .source(TransformOperationSourceProperty.builder()
                 .transformOperationId("transformOperationId")
                 // the properties below are optional
                 .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                         .sourceColumnId("sourceColumnId")
                         .targetColumnId("targetColumnId")
                         .build()))
                 .build())
         // the properties below are optional
         .groupByColumnNames(List.of("groupByColumnNames"))
         .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	CfnDataSet.AggregateOperationProperty.Builder	A builder for CfnDataSet.AggregateOperationProperty
static final class	CfnDataSet.AggregateOperationProperty.Jsii$Proxy	An implementation for CfnDataSet.AggregateOperationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.AggregateOperationProperty.Builder	builder()
Object	getAggregations()	The list of aggregation functions to apply to the grouped data, such as SUM , COUNT , or AVERAGE .
String	getAlias()	Alias for this operation.
default List<String>	getGroupByColumnNames()	The list of column names to group by when performing the aggregation.
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)
@NotNull
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 CfnDataSet.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)
@NotNull
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

getSource

@Stability(Stable)
@NotNull
Object getSource()

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

Returns union: either IResolvable or CfnDataSet.TransformOperationSourceProperty

See Also:

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

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

builder

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

Returns:

a CfnDataSet.AggregateOperationProperty.Builder of CfnDataSet.AggregateOperationProperty