Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.PredefinedHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.PredefinedHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.PredefinedHierarchyProperty
extends software.amazon.jsii.JsiiSerializable

The option that determines the hierarchy of the fields that are defined during data preparation.

These fields are available to use in any analysis that uses the data source.

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.*;
 PredefinedHierarchyProperty predefinedHierarchyProperty = PredefinedHierarchyProperty.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-analysis-predefinedhierarchy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.PredefinedHierarchyProperty.Builder	builder()
Object	getColumns()	The list of columns that define the predefined hierarchy.
default Object	getDrillDownFilters()	The option that determines the drill down filters for the predefined hierarchy.
String	getHierarchyId()	The hierarchy ID of the predefined 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 predefined hierarchy.

See Also:

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

getHierarchyId

@Stability(Stable)
@NotNull
String getHierarchyId()

The hierarchy ID of the predefined hierarchy.

See Also:

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

getDrillDownFilters

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

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

See Also:

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

builder

@Stability(Stable)
static CfnAnalysis.PredefinedHierarchyProperty.Builder builder()

Returns:

a CfnAnalysis.PredefinedHierarchyProperty.Builder of CfnAnalysis.PredefinedHierarchyProperty