cloudshift.awscdk.dsl.services.quicksight.CfnTemplateColumnHierarchyPropertyDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier", "RedundantUnitReturnType", "RemoveRedundantQualifierName", "unused", "UnusedImport", "ClassName", "REDUNDANT_PROJECTION", "DEPRECATION")
package cloudshift.awscdk.dsl.services.quicksight
import cloudshift.awscdk.common.CdkDslMarker
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.quicksight.CfnTemplate
/**
* 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();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnhierarchy.html)
*/
@CdkDslMarker
public class CfnTemplateColumnHierarchyPropertyDsl {
private val cdkBuilder: CfnTemplate.ColumnHierarchyProperty.Builder =
CfnTemplate.ColumnHierarchyProperty.builder()
/**
* @param dateTimeHierarchy The option that determines the hierarchy of any `DateTime` fields.
*/
public fun dateTimeHierarchy(dateTimeHierarchy: IResolvable) {
cdkBuilder.dateTimeHierarchy(dateTimeHierarchy)
}
/**
* @param dateTimeHierarchy The option that determines the hierarchy of any `DateTime` fields.
*/
public fun dateTimeHierarchy(dateTimeHierarchy: CfnTemplate.DateTimeHierarchyProperty) {
cdkBuilder.dateTimeHierarchy(dateTimeHierarchy)
}
/**
* @param explicitHierarchy 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.
*/
public fun explicitHierarchy(explicitHierarchy: IResolvable) {
cdkBuilder.explicitHierarchy(explicitHierarchy)
}
/**
* @param explicitHierarchy 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.
*/
public fun explicitHierarchy(explicitHierarchy: CfnTemplate.ExplicitHierarchyProperty) {
cdkBuilder.explicitHierarchy(explicitHierarchy)
}
/**
* @param predefinedHierarchy 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.
*/
public fun predefinedHierarchy(predefinedHierarchy: IResolvable) {
cdkBuilder.predefinedHierarchy(predefinedHierarchy)
}
/**
* @param predefinedHierarchy 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.
*/
public fun predefinedHierarchy(predefinedHierarchy: CfnTemplate.PredefinedHierarchyProperty) {
cdkBuilder.predefinedHierarchy(predefinedHierarchy)
}
public fun build(): CfnTemplate.ColumnHierarchyProperty = cdkBuilder.build()
}