Package 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(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")
                         .subType("subType")
                         .build())
                 .createColumnsOperation(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())
                 .filterOperation(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())
                 .overrideDatasetParameterOperation(OverrideDatasetParameterOperationProperty.builder()
                         .parameterName("parameterName")
                         // the properties below are optional
                         .newDefaultValues(NewDefaultValuesProperty.builder()
                                 .dateTimeStaticValues(List.of("dateTimeStaticValues"))
                                 .decimalStaticValues(List.of(123))
                                 .integerStaticValues(List.of(123))
                                 .stringStaticValues(List.of("stringStaticValues"))
                                 .build())
                         .newParameterName("newParameterName")
                         .build())
                 .projectOperation(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())
                 .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())
                 .untagColumnOperation(UntagColumnOperationProperty.builder()
                         .columnName("columnName")
                         .tagNames(List.of("tagNames"))
                         .build())
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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()	Information about the source of a logical table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

A display name for the logical table.

.

See Also:

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

getSource

@Stability(Stable)
@NotNull
Object getSource()

Information about the source of a logical table.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Returns union: either IResolvable or CfnDataSet.LogicalTableSourceProperty

See Also:

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

getDataTransforms

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

Transform operations that act on this logical table.

For this structure to be valid, only one of the attributes can be non-null.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.TransformOperationProperty>

See Also:

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

builder

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

Returns:

a CfnDataSet.LogicalTableProperty.Builder of CfnDataSet.LogicalTableProperty