Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.MeasureFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.MeasureFieldProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.MeasureFieldProperty
extends software.amazon.jsii.JsiiSerializable

The measure (metric) type field.

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.*;
 MeasureFieldProperty measureFieldProperty = 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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .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()
                                                         .groupingStyle("groupingStyle")
                                                         .symbol("symbol")
                                                         .visibility("visibility")
                                                         .build())
                                                 .build())
                                         .suffix("suffix")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.MeasureFieldProperty.Builder	builder()
default Object	getCalculatedMeasureField()	The calculated measure field only used in pivot tables.
default Object	getCategoricalMeasureField()	The measure type field with categorical type columns.
default Object	getDateMeasureField()	The measure type field with date type columns.
default Object	getNumericalMeasureField()	The measure type field with numerical type columns.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCalculatedMeasureField

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

The calculated measure field only used in pivot tables.

Returns union: either IResolvable or CfnDashboard.CalculatedMeasureFieldProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-calculatedmeasurefield

getCategoricalMeasureField

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

The measure type field with categorical type columns.

Returns union: either IResolvable or CfnDashboard.CategoricalMeasureFieldProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-categoricalmeasurefield

getDateMeasureField

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

The measure type field with date type columns.

Returns union: either IResolvable or CfnDashboard.DateMeasureFieldProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-datemeasurefield

getNumericalMeasureField

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

The measure type field with numerical type columns.

Returns union: either IResolvable or CfnDashboard.NumericalMeasureFieldProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-measurefield.html#cfn-quicksight-dashboard-measurefield-numericalmeasurefield

builder

@Stability(Stable)
static CfnDashboard.MeasureFieldProperty.Builder builder()

Returns:

a CfnDashboard.MeasureFieldProperty.Builder of CfnDashboard.MeasureFieldProperty