Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.JoinInstructionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.JoinInstructionProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

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

The instructions associated with a join.

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.*;
 JoinInstructionProperty joinInstructionProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.JoinInstructionProperty.Builder	builder()
default Object	getLeftJoinKeyProperties()	Join key properties of the left operand.
String	getLeftOperand()	The operand on the left side of a join.
String	getOnClause()	The join instructions provided in the ON clause of a join.
default Object	getRightJoinKeyProperties()	Join key properties of the right operand.
String	getRightOperand()	The operand on the right side of a join.
String	getType()	The type of join that it is.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLeftOperand

@Stability(Stable)
@NotNull
String getLeftOperand()

The operand on the left side of a join.

See Also:

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

getOnClause

@Stability(Stable)
@NotNull
String getOnClause()

The join instructions provided in the ON clause of a join.

See Also:

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

getRightOperand

@Stability(Stable)
@NotNull
String getRightOperand()

The operand on the right side of a join.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of join that it is.

See Also:

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

getLeftJoinKeyProperties

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

Join key properties of the left operand.

Returns union: either IResolvable or CfnDataSet.JoinKeyPropertiesProperty

See Also:

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

getRightJoinKeyProperties

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

Join key properties of the right operand.

Returns union: either IResolvable or CfnDataSet.JoinKeyPropertiesProperty

See Also:

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

builder

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

Returns:

a CfnDataSet.JoinInstructionProperty.Builder of CfnDataSet.JoinInstructionProperty