Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSetPropsMixin.JoinOperationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSetPropsMixin.JoinOperationProperty.Jsii$Proxy

Enclosing class:

CfnDataSetPropsMixin

@Stability(Stable)
public static interface CfnDataSetPropsMixin.JoinOperationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 JoinOperationProperty joinOperationProperty = JoinOperationProperty.builder()
         .alias("alias")
         .leftOperand(TransformOperationSourceProperty.builder()
                 .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                         .sourceColumnId("sourceColumnId")
                         .targetColumnId("targetColumnId")
                         .build()))
                 .transformOperationId("transformOperationId")
                 .build())
         .leftOperandProperties(JoinOperandPropertiesProperty.builder()
                 .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                         .outputColumnName("outputColumnName")
                         .sourceColumnName("sourceColumnName")
                         .build()))
                 .build())
         .onClause("onClause")
         .rightOperand(TransformOperationSourceProperty.builder()
                 .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                         .sourceColumnId("sourceColumnId")
                         .targetColumnId("targetColumnId")
                         .build()))
                 .transformOperationId("transformOperationId")
                 .build())
         .rightOperandProperties(JoinOperandPropertiesProperty.builder()
                 .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                         .outputColumnName("outputColumnName")
                         .sourceColumnName("sourceColumnName")
                         .build()))
                 .build())
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSetPropsMixin.JoinOperationProperty.Builder	builder()
default String	getAlias()	Alias for this operation.
default Object	getLeftOperand()	The left operand for the join operation.
default Object	getLeftOperandProperties()	Properties that control how the left operand's columns are handled in the join result.
default String	getOnClause()	The join condition that specifies how to match rows between the left and right operands.
default Object	getRightOperand()	The right operand for the join operation.
default Object	getRightOperandProperties()	Properties that control how the right operand's columns are handled in the join result.
default String	getType()	The type of join to perform, such as INNER , LEFT , RIGHT , or OUTER .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

Alias for this operation.

See Also:

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

getLeftOperand

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

The left operand for the join operation.

Returns union: either IResolvable or CfnDataSetPropsMixin.TransformOperationSourceProperty

See Also:

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

getLeftOperandProperties

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

Properties that control how the left operand's columns are handled in the join result.

Returns union: either IResolvable or CfnDataSetPropsMixin.JoinOperandPropertiesProperty

See Also:

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

getOnClause

@Stability(Stable)
@Nullable
default String getOnClause()

The join condition that specifies how to match rows between the left and right operands.

See Also:

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

getRightOperand

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

The right operand for the join operation.

Returns union: either IResolvable or CfnDataSetPropsMixin.TransformOperationSourceProperty

See Also:

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

getRightOperandProperties

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

Properties that control how the right operand's columns are handled in the join result.

Returns union: either IResolvable or CfnDataSetPropsMixin.JoinOperandPropertiesProperty

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The type of join to perform, such as INNER , LEFT , RIGHT , or OUTER .

See Also:

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

builder

@Stability(Stable)
static CfnDataSetPropsMixin.JoinOperationProperty.Builder builder()

Returns:

a CfnDataSetPropsMixin.JoinOperationProperty.Builder of CfnDataSetPropsMixin.JoinOperationProperty