software.amazon.awscdk.services.quicksight

Interface CfnDataSet.LogicalTableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.LogicalTableProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(value=Stable)
public static interface CfnDataSet.LogicalTableProperty
extends software.amazon.jsii.JsiiSerializable

A *logical table* is a unit that joins and that data transformations operate on.

A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

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.*;
 LogicalTableProperty logicalTableProperty = LogicalTableProperty.builder()
         .alias("alias")
         .source(LogicalTableSourceProperty.builder()
                 .dataSetArn("dataSetArn")
                 .joinInstruction(JoinInstructionProperty.builder()
                         .leftOperand("leftOperand")
                         .onClause("onClause")
                         .rightOperand("rightOperand")
                         .type("type")
                         // the properties below are optional
                         .leftJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                 .uniqueKey(false)
                                 .build())
                         .rightJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                 .uniqueKey(false)
                                 .build())
                         .build())
                 .physicalTableId("physicalTableId")
                 .build())
         // the properties below are optional
         .dataTransforms(List.of(TransformOperationProperty.builder()
                 .castColumnTypeOperation(CastColumnTypeOperationProperty.builder()
                         .columnName("columnName")
                         .newColumnType("newColumnType")
                         // the properties below are optional
                         .format("format")
                         .build())
                 .createColumnsOperation(CreateColumnsOperationProperty.builder()
                         .columns(List.of(CalculatedColumnProperty.builder()
                                 .columnId("columnId")
                                 .columnName("columnName")
                                 .expression("expression")
                                 .build()))
                         .build())
                 .filterOperation(FilterOperationProperty.builder()
                         .conditionExpression("conditionExpression")
                         .build())
                 .projectOperation(ProjectOperationProperty.builder()
                         .projectedColumns(List.of("projectedColumns"))
                         .build())
                 .renameColumnOperation(RenameColumnOperationProperty.builder()
                         .columnName("columnName")
                         .newColumnName("newColumnName")
                         .build())
                 .tagColumnOperation(TagColumnOperationProperty.builder()
                         .columnName("columnName")
                         .tags(List.of(ColumnTagProperty.builder()
                                 .columnDescription(ColumnDescriptionProperty.builder()
                                         .text("text")
                                         .build())
                                 .columnGeographicRole("columnGeographicRole")
                                 .build()))
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSet.LogicalTableProperty.Builder	builder()
String	getAlias() A display name for the logical table.
default Object	getDataTransforms() Transform operations that act on this logical table.
Object	getSource() Source of this logical table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlias

@Stability(value=Stable)
 @NotNull
String getAlias()

A display name for the logical table.

getSource

@Stability(value=Stable)
 @NotNull
Object getSource()

Source of this logical table.

getDataTransforms

@Stability(value=Stable)
 @Nullable
default Object getDataTransforms()

Transform operations that act on this logical table.

builder

@Stability(value=Stable)
static CfnDataSet.LogicalTableProperty.Builder builder()

Returns:

a CfnDataSet.LogicalTableProperty.Builder of CfnDataSet.LogicalTableProperty