Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.ExplicitHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.ExplicitHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.ExplicitHierarchyProperty
extends software.amazon.jsii.JsiiSerializable

The option that determines the hierarchy of the fields that are built within a visual's field wells.

These fields can't be duplicated to other visuals.

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.*;
 ExplicitHierarchyProperty explicitHierarchyProperty = ExplicitHierarchyProperty.builder()
         .columns(List.of(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build()))
         .hierarchyId("hierarchyId")
         // the properties below are optional
         .drillDownFilters(List.of(DrillDownFilterProperty.builder()
                 .categoryFilter(CategoryDrillDownFilterProperty.builder()
                         .categoryValues(List.of("categoryValues"))
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .build())
                 .numericEqualityFilter(NumericEqualityDrillDownFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .value(123)
                         .build())
                 .timeRangeFilter(TimeRangeDrillDownFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .rangeMaximum("rangeMaximum")
                         .rangeMinimum("rangeMinimum")
                         .timeGranularity("timeGranularity")
                         .build())
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.ExplicitHierarchyProperty.Builder	builder()
Object	getColumns()	The list of columns that define the explicit hierarchy.
default Object	getDrillDownFilters()	The option that determines the drill down filters for the explicit hierarchy.
String	getHierarchyId()	The hierarchy ID of the explicit hierarchy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumns

@Stability(Stable)
@NotNull
Object getColumns()

The list of columns that define the explicit hierarchy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-columns

getHierarchyId

@Stability(Stable)
@NotNull
String getHierarchyId()

The hierarchy ID of the explicit hierarchy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-hierarchyid

getDrillDownFilters

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

The option that determines the drill down filters for the explicit hierarchy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-explicithierarchy.html#cfn-quicksight-dashboard-explicithierarchy-drilldownfilters

builder

@Stability(Stable)
static CfnDashboard.ExplicitHierarchyProperty.Builder builder()

Returns:

a CfnDashboard.ExplicitHierarchyProperty.Builder of CfnDashboard.ExplicitHierarchyProperty