Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.PivotOperationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.PivotOperationProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.PivotOperationProperty
extends software.amazon.jsii.JsiiSerializable

A transform operation that pivots data by converting row values into columns.

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.*;
 PivotOperationProperty pivotOperationProperty = PivotOperationProperty.builder()
         .alias("alias")
         .pivotConfiguration(PivotConfigurationProperty.builder()
                 .pivotedLabels(List.of(PivotedLabelProperty.builder()
                         .labelName("labelName")
                         .newColumnId("newColumnId")
                         .newColumnName("newColumnName")
                         .build()))
                 // the properties below are optional
                 .labelColumnName("labelColumnName")
                 .build())
         .source(TransformOperationSourceProperty.builder()
                 .transformOperationId("transformOperationId")
                 // the properties below are optional
                 .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                         .sourceColumnId("sourceColumnId")
                         .targetColumnId("targetColumnId")
                         .build()))
                 .build())
         .valueColumnConfiguration(ValueColumnConfigurationProperty.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())
                 .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-pivotoperation.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.PivotOperationProperty.Builder	builder()
String	getAlias()	Alias for this operation.
default List<String>	getGroupByColumnNames()	The list of column names to group by when performing the pivot operation.
Object	getPivotConfiguration()	Configuration that specifies which labels to pivot and how to structure the resulting columns.
Object	getSource()	The source transform operation that provides input data for pivoting.
Object	getValueColumnConfiguration()	Configuration for how to aggregate values when multiple rows map to the same pivoted column.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

Alias for this operation.

See Also:

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

getPivotConfiguration

@Stability(Stable)
@NotNull
Object getPivotConfiguration()

Configuration that specifies which labels to pivot and how to structure the resulting columns.

Returns union: either IResolvable or CfnDataSet.PivotConfigurationProperty

See Also:

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

getSource

@Stability(Stable)
@NotNull
Object getSource()

The source transform operation that provides input data for pivoting.

Returns union: either IResolvable or CfnDataSet.TransformOperationSourceProperty

See Also:

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

getValueColumnConfiguration

@Stability(Stable)
@NotNull
Object getValueColumnConfiguration()

Configuration for how to aggregate values when multiple rows map to the same pivoted column.

Returns union: either IResolvable or CfnDataSet.ValueColumnConfigurationProperty

See Also:

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

getGroupByColumnNames

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

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

See Also:

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

builder

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

Returns:

a CfnDataSet.PivotOperationProperty.Builder of CfnDataSet.PivotOperationProperty