Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.UnaggregatedFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.UnaggregatedFieldProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.UnaggregatedFieldProperty
extends software.amazon.jsii.JsiiSerializable

The unaggregated field for a table.

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.*;
 UnaggregatedFieldProperty unaggregatedFieldProperty = UnaggregatedFieldProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .fieldId("fieldId")
         // the properties below are optional
         .formatConfiguration(FormatConfigurationProperty.builder()
                 .dateTimeFormatConfiguration(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())
                 .numberFormatConfiguration(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())
                 .stringFormatConfiguration(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.UnaggregatedFieldProperty.Builder	builder()
Object	getColumn()	The column that is used in the UnaggregatedField .
String	getFieldId()	The custom field ID.
default Object	getFormatConfiguration()	The format configuration of the field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that is used in the UnaggregatedField .

See Also:

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

getFieldId

@Stability(Stable)
@NotNull
String getFieldId()

The custom field ID.

See Also:

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

getFormatConfiguration

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

The format configuration of the field.

See Also:

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

builder

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

Returns:

a CfnTemplate.UnaggregatedFieldProperty.Builder of CfnTemplate.UnaggregatedFieldProperty