cloudshift.awscdk.dsl.services.quicksight.CfnDashboardWordCloudAggregatedFieldWellsPropertyDsl.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.CfnDashboard
import kotlin.Any
import kotlin.collections.Collection
import kotlin.collections.MutableList
/**
* The aggregated field wells of a word cloud.
*
* 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.*;
* WordCloudAggregatedFieldWellsProperty wordCloudAggregatedFieldWellsProperty =
* WordCloudAggregatedFieldWellsProperty.builder()
* .groupBy(List.of(DimensionFieldProperty.builder()
* .categoricalDimensionField(CategoricalDimensionFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .formatConfiguration(StringFormatConfigurationProperty.builder()
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .hierarchyId("hierarchyId")
* .build())
* .dateDimensionField(DateDimensionFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .dateGranularity("dateGranularity")
* .formatConfiguration(DateTimeFormatConfigurationProperty.builder()
* .dateTimeFormat("dateTimeFormat")
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .hierarchyId("hierarchyId")
* .build())
* .numericalDimensionField(NumericalDimensionFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .formatConfiguration(NumberFormatConfigurationProperty.builder()
* .formatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .hierarchyId("hierarchyId")
* .build())
* .build()))
* .size(List.of(MeasureFieldProperty.builder()
* .calculatedMeasureField(CalculatedMeasureFieldProperty.builder()
* .expression("expression")
* .fieldId("fieldId")
* .build())
* .categoricalMeasureField(CategoricalMeasureFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .aggregationFunction("aggregationFunction")
* .formatConfiguration(StringFormatConfigurationProperty.builder()
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .build())
* .dateMeasureField(DateMeasureFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .aggregationFunction("aggregationFunction")
* .formatConfiguration(DateTimeFormatConfigurationProperty.builder()
* .dateTimeFormat("dateTimeFormat")
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .build())
* .numericalMeasureField(NumericalMeasureFieldProperty.builder()
* .column(ColumnIdentifierProperty.builder()
* .columnName("columnName")
* .dataSetIdentifier("dataSetIdentifier")
* .build())
* .fieldId("fieldId")
* // the properties below are optional
* .aggregationFunction(NumericalAggregationFunctionProperty.builder()
* .percentileAggregation(PercentileAggregationProperty.builder()
* .percentileValue(123)
* .build())
* .simpleNumericalAggregation("simpleNumericalAggregation")
* .build())
* .formatConfiguration(NumberFormatConfigurationProperty.builder()
* .formatConfiguration(NumericFormatConfigurationProperty.builder()
* .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .symbol("symbol")
* .build())
* .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .numberScale("numberScale")
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
* .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
* .decimalPlaces(123)
* .build())
* .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
* .displayMode("displayMode")
* .build())
* .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
* .nullString("nullString")
* .build())
* .prefix("prefix")
* .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
* .decimalSeparator("decimalSeparator")
* .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
* .symbol("symbol")
* .visibility("visibility")
* .build())
* .build())
* .suffix("suffix")
* .build())
* .build())
* .build())
* .build())
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-wordcloudaggregatedfieldwells.html)
*/
@CdkDslMarker
public class CfnDashboardWordCloudAggregatedFieldWellsPropertyDsl {
private val cdkBuilder: CfnDashboard.WordCloudAggregatedFieldWellsProperty.Builder =
CfnDashboard.WordCloudAggregatedFieldWellsProperty.builder()
private val _groupBy: MutableList = mutableListOf()
private val _size: MutableList = mutableListOf()
/**
* @param groupBy The group by field well of a word cloud.
* Values are grouped by group by fields.
*/
public fun groupBy(vararg groupBy: Any) {
_groupBy.addAll(listOf(*groupBy))
}
/**
* @param groupBy The group by field well of a word cloud.
* Values are grouped by group by fields.
*/
public fun groupBy(groupBy: Collection) {
_groupBy.addAll(groupBy)
}
/**
* @param groupBy The group by field well of a word cloud.
* Values are grouped by group by fields.
*/
public fun groupBy(groupBy: IResolvable) {
cdkBuilder.groupBy(groupBy)
}
/**
* @param size The size field well of a word cloud.
* Values are aggregated based on group by fields.
*/
public fun size(vararg size: Any) {
_size.addAll(listOf(*size))
}
/**
* @param size The size field well of a word cloud.
* Values are aggregated based on group by fields.
*/
public fun size(size: Collection) {
_size.addAll(size)
}
/**
* @param size The size field well of a word cloud.
* Values are aggregated based on group by fields.
*/
public fun size(size: IResolvable) {
cdkBuilder.size(size)
}
public fun build(): CfnDashboard.WordCloudAggregatedFieldWellsProperty {
if (_groupBy.isNotEmpty()) cdkBuilder.groupBy(_groupBy)
if (_size.isNotEmpty()) cdkBuilder.size(_size)
return cdkBuilder.build()
}
}