Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.DateDimensionFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.DateDimensionFieldProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

The dimension type field with date type columns.

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.*;
 DateDimensionFieldProperty dateDimensionFieldProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.DateDimensionFieldProperty.Builder	builder()
Object	getColumn()	The column that is used in the DateDimensionField .
default String	getDateGranularity()	The date granularity of the DateDimensionField .
String	getFieldId()	The custom field ID.
default Object	getFormatConfiguration()	The format configuration of the field.
default String	getHierarchyId()	The custom hierarchy ID.

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 DateDimensionField .

getFieldId

@Stability(Stable)
@NotNull
String getFieldId()

The custom field ID.

getDateGranularity

@Stability(Stable)
@Nullable
default String getDateGranularity()

The date granularity of the DateDimensionField . Choose one of the following options:.

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

getFormatConfiguration

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

The format configuration of the field.

getHierarchyId

@Stability(Stable)
@Nullable
default String getHierarchyId()

The custom hierarchy ID.

builder

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

Returns:

a CfnTemplate.DateDimensionFieldProperty.Builder of CfnTemplate.DateDimensionFieldProperty