All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSet.TransformStepProperty.Jsii$Proxy

Enclosing class:: CfnDataSet

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

A step in data preparation that performs a specific operation on the data.

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.*;
 TransformStepProperty transformStepProperty = TransformStepProperty.builder()
         .aggregateStep(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())
         .appendStep(AppendOperationProperty.builder()
                 .alias("alias")
                 .appendedColumns(List.of(AppendedColumnProperty.builder()
                         .columnName("columnName")
                         .newColumnId("newColumnId")
                         .build()))
                 // the properties below are optional
                 .firstSource(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .secondSource(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .castColumnTypesStep(CastColumnTypesOperationProperty.builder()
                 .alias("alias")
                 .castColumnTypeOperations(List.of(CastColumnTypeOperationProperty.builder()
                         .columnName("columnName")
                         .newColumnType("newColumnType")
                         // the properties below are optional
                         .format("format")
                         .subType("subType")
                         .build()))
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .createColumnsStep(CreateColumnsOperationProperty.builder()
                 .columns(List.of(CalculatedColumnProperty.builder()
                         .columnId("columnId")
                         .columnName("columnName")
                         .expression("expression")
                         .build()))
                 // the properties below are optional
                 .alias("alias")
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .filtersStep(FiltersOperationProperty.builder()
                 .alias("alias")
                 .filterOperations(List.of(FilterOperationProperty.builder()
                         .conditionExpression("conditionExpression")
                         .dateFilterCondition(DataSetDateFilterConditionProperty.builder()
                                 .columnName("columnName")
                                 .comparisonFilterCondition(DataSetDateComparisonFilterConditionProperty.builder()
                                         .operator("operator")
                                         // the properties below are optional
                                         .value(DataSetDateFilterValueProperty.builder()
                                                 .staticValue("staticValue")
                                                 .build())
                                         .build())
                                 .rangeFilterCondition(DataSetDateRangeFilterConditionProperty.builder()
                                         .includeMaximum(false)
                                         .includeMinimum(false)
                                         .rangeMaximum(DataSetDateFilterValueProperty.builder()
                                                 .staticValue("staticValue")
                                                 .build())
                                         .rangeMinimum(DataSetDateFilterValueProperty.builder()
                                                 .staticValue("staticValue")
                                                 .build())
                                         .build())
                                 .build())
                         .numericFilterCondition(DataSetNumericFilterConditionProperty.builder()
                                 .columnName("columnName")
                                 .comparisonFilterCondition(DataSetNumericComparisonFilterConditionProperty.builder()
                                         .operator("operator")
                                         // the properties below are optional
                                         .value(DataSetNumericFilterValueProperty.builder()
                                                 .staticValue(123)
                                                 .build())
                                         .build())
                                 .rangeFilterCondition(DataSetNumericRangeFilterConditionProperty.builder()
                                         .includeMaximum(false)
                                         .includeMinimum(false)
                                         .rangeMaximum(DataSetNumericFilterValueProperty.builder()
                                                 .staticValue(123)
                                                 .build())
                                         .rangeMinimum(DataSetNumericFilterValueProperty.builder()
                                                 .staticValue(123)
                                                 .build())
                                         .build())
                                 .build())
                         .stringFilterCondition(DataSetStringFilterConditionProperty.builder()
                                 .columnName("columnName")
                                 .comparisonFilterCondition(DataSetStringComparisonFilterConditionProperty.builder()
                                         .operator("operator")
                                         // the properties below are optional
                                         .value(DataSetStringFilterValueProperty.builder()
                                                 .staticValue("staticValue")
                                                 .build())
                                         .build())
                                 .listFilterCondition(DataSetStringListFilterConditionProperty.builder()
                                         .operator("operator")
                                         // the properties below are optional
                                         .values(DataSetStringListFilterValueProperty.builder()
                                                 .staticValues(List.of("staticValues"))
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .importTableStep(ImportTableOperationProperty.builder()
                 .alias("alias")
                 .source(ImportTableOperationSourceProperty.builder()
                         .sourceTableId("sourceTableId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .joinStep(JoinOperationProperty.builder()
                 .alias("alias")
                 .leftOperand(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .onClause("onClause")
                 .rightOperand(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .type("type")
                 // the properties below are optional
                 .leftOperandProperties(JoinOperandPropertiesProperty.builder()
                         .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                                 .outputColumnName("outputColumnName")
                                 // the properties below are optional
                                 .sourceColumnName("sourceColumnName")
                                 .build()))
                         .build())
                 .rightOperandProperties(JoinOperandPropertiesProperty.builder()
                         .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                                 .outputColumnName("outputColumnName")
                                 // the properties below are optional
                                 .sourceColumnName("sourceColumnName")
                                 .build()))
                         .build())
                 .build())
         .pivotStep(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())
         .projectStep(ProjectOperationProperty.builder()
                 .alias("alias")
                 .projectedColumns(List.of("projectedColumns"))
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .renameColumnsStep(RenameColumnsOperationProperty.builder()
                 .alias("alias")
                 .renameColumnOperations(List.of(RenameColumnOperationProperty.builder()
                         .columnName("columnName")
                         .newColumnName("newColumnName")
                         .build()))
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .build())
         .unpivotStep(UnpivotOperationProperty.builder()
                 .alias("alias")
                 .columnsToUnpivot(List.of(ColumnToUnpivotProperty.builder()
                         .columnName("columnName")
                         .newValue("newValue")
                         .build()))
                 .source(TransformOperationSourceProperty.builder()
                         .transformOperationId("transformOperationId")
                         // the properties below are optional
                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                 .sourceColumnId("sourceColumnId")
                                 .targetColumnId("targetColumnId")
                                 .build()))
                         .build())
                 .unpivotedLabelColumnId("unpivotedLabelColumnId")
                 .unpivotedLabelColumnName("unpivotedLabelColumnName")
                 .unpivotedValueColumnId("unpivotedValueColumnId")
                 .unpivotedValueColumnName("unpivotedValueColumnName")
                 .build())
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDataSet.TransformStepProperty.Builder

A builder for CfnDataSet.TransformStepProperty

static final class

CfnDataSet.TransformStepProperty.Jsii$Proxy

An implementation for CfnDataSet.TransformStepProperty
Method Summary

Modifier and Type

Method

Description

static CfnDataSet.TransformStepProperty.Builder

builder()

default Object

getAggregateStep()

A transform step that groups data and applies aggregation functions to calculate summary values.

default Object

getAppendStep()

A transform step that combines rows from multiple sources by stacking them vertically.

default Object

getCastColumnTypesStep()

A transform step that changes the data types of one or more columns.

default Object

getCreateColumnsStep()

A transform operation that creates calculated columns.

default Object

getFiltersStep()

A transform step that applies filter conditions.

default Object

getImportTableStep()

A transform step that brings data from a source table.

default Object

getJoinStep()

A transform step that combines data from two sources based on specified join conditions.

default Object

getPivotStep()

A transform step that converts row values into columns to reshape the data structure.

default Object

getProjectStep()

A transform operation that projects columns.

default Object

getRenameColumnsStep()

A transform step that changes the names of one or more columns.

default Object

getUnpivotStep()

A transform step that converts columns into rows to normalize the data structure.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAggregateStep
  
  @Stability(Stable) @Nullable default Object getAggregateStep()
  
  A transform step that groups data and applies aggregation functions to calculate summary values.
  Returns union: either IResolvable or CfnDataSet.AggregateOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-aggregatestep
- getAppendStep
  
  @Stability(Stable) @Nullable default Object getAppendStep()
  
  A transform step that combines rows from multiple sources by stacking them vertically.
  Returns union: either IResolvable or CfnDataSet.AppendOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-appendstep
- getCastColumnTypesStep
  
  @Stability(Stable) @Nullable default Object getCastColumnTypesStep()
  
  A transform step that changes the data types of one or more columns.
  Returns union: either IResolvable or CfnDataSet.CastColumnTypesOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-castcolumntypesstep
- getCreateColumnsStep
  
  @Stability(Stable) @Nullable default Object getCreateColumnsStep()
  
  A transform operation that creates calculated columns.
  Columns created in one such operation form a lexical closure.
  
  Returns union: either IResolvable or CfnDataSet.CreateColumnsOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-createcolumnsstep
- getFiltersStep
  
  @Stability(Stable) @Nullable default Object getFiltersStep()
  
  A transform step that applies filter conditions.
  Returns union: either IResolvable or CfnDataSet.FiltersOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-filtersstep
- getImportTableStep
  
  @Stability(Stable) @Nullable default Object getImportTableStep()
  
  A transform step that brings data from a source table.
  Returns union: either IResolvable or CfnDataSet.ImportTableOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-importtablestep
- getJoinStep
  
  @Stability(Stable) @Nullable default Object getJoinStep()
  
  A transform step that combines data from two sources based on specified join conditions.
  Returns union: either IResolvable or CfnDataSet.JoinOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-joinstep
- getPivotStep
  
  @Stability(Stable) @Nullable default Object getPivotStep()
  
  A transform step that converts row values into columns to reshape the data structure.
  Returns union: either IResolvable or CfnDataSet.PivotOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-pivotstep
- getProjectStep
  
  @Stability(Stable) @Nullable default Object getProjectStep()
  
  A transform operation that projects columns.
  Operations that come after a projection can only refer to projected columns.
  
  Returns union: either IResolvable or CfnDataSet.ProjectOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-projectstep
- getRenameColumnsStep
  
  @Stability(Stable) @Nullable default Object getRenameColumnsStep()
  
  A transform step that changes the names of one or more columns.
  Returns union: either IResolvable or CfnDataSet.RenameColumnsOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-renamecolumnsstep
- getUnpivotStep
  
  @Stability(Stable) @Nullable default Object getUnpivotStep()
  
  A transform step that converts columns into rows to normalize the data structure.
  Returns union: either IResolvable or CfnDataSet.UnpivotOperationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformstep.html#cfn-quicksight-dataset-transformstep-unpivotstep
- builder
  
  @Stability(Stable) static CfnDataSet.TransformStepProperty.Builder builder()
  
  Returns:
  
  a CfnDataSet.TransformStepProperty.Builder of CfnDataSet.TransformStepProperty

Interface CfnDataSet.TransformStepProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAggregateStep

getAppendStep

getCastColumnTypesStep

getCreateColumnsStep

getFiltersStep

getImportTableStep

getJoinStep

getPivotStep

getProjectStep

getRenameColumnsStep

getUnpivotStep

builder