Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.ColumnHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.ColumnHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.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-template-columnhierarchy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.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.

Returns union: either IResolvable or CfnTemplate.DateTimeHierarchyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-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.

Returns union: either IResolvable or CfnTemplate.ExplicitHierarchyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html#cfn-quicksight-template-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.

Returns union: either IResolvable or CfnTemplate.PredefinedHierarchyProperty

See Also:

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

builder

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

Returns:

a CfnTemplate.ColumnHierarchyProperty.Builder of CfnTemplate.ColumnHierarchyProperty