Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.JoinOperationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.JoinOperationProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.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.services.quicksight.*;
 JoinOperationProperty joinOperationProperty = 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();
 

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	CfnDataSet.JoinOperationProperty.Builder	A builder for CfnDataSet.JoinOperationProperty
static final class	CfnDataSet.JoinOperationProperty.Jsii$Proxy	An implementation for CfnDataSet.JoinOperationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.JoinOperationProperty.Builder	builder()
String	getAlias()	Alias for this operation.
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.
String	getOnClause()	The join condition that specifies how to match rows between the left and right operands.
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.
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)
@NotNull
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)
@NotNull
Object getLeftOperand()

The left operand for the join operation.

Returns union: either IResolvable or CfnDataSet.TransformOperationSourceProperty

See Also:

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

getOnClause

@Stability(Stable)
@NotNull
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)
@NotNull
Object getRightOperand()

The right operand for the join operation.

Returns union: either IResolvable or CfnDataSet.TransformOperationSourceProperty

See Also:

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

getType

@Stability(Stable)
@NotNull
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

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 CfnDataSet.JoinOperandPropertiesProperty

See Also:

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

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 CfnDataSet.JoinOperandPropertiesProperty

See Also:

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

builder

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

Returns:

a CfnDataSet.JoinOperationProperty.Builder of CfnDataSet.JoinOperationProperty