Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.ColumnHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.ColumnHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

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

The option that determines the hierarchy of the fields for a visual element.

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.*;
 ColumnHierarchyProperty columnHierarchyProperty = ColumnHierarchyProperty.builder()
         .dateTimeHierarchy(DateTimeHierarchyProperty.builder()
                 .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())
         .explicitHierarchy(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())
         .predefinedHierarchy(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.ColumnHierarchyProperty.Builder	builder()
default Object	getDateTimeHierarchy()	The option that determines the hierarchy of any DateTime fields.
default Object	getExplicitHierarchy()	The option that determines the hierarchy of the fields that are built within a visual's field wells.
default Object	getPredefinedHierarchy()	The option that determines the hierarchy of the fields that are defined during data preparation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDateTimeHierarchy

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

The option that determines the hierarchy of any DateTime fields.

See Also:

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

getExplicitHierarchy

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

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.

See Also:

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

getPredefinedHierarchy

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

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.

See Also:

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

builder

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

Returns:

a CfnAnalysis.ColumnHierarchyProperty.Builder of CfnAnalysis.ColumnHierarchyProperty