Interface CfnTemplate.ForecastComputationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.ForecastComputationProperty.Jsii$Proxy
- Enclosing class:
- CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.ForecastComputationProperty
extends software.amazon.jsii.JsiiSerializable
The forecast computation configuration.
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.*;
ForecastComputationProperty forecastComputationProperty = ForecastComputationProperty.builder()
.computationId("computationId")
.time(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())
// the properties below are optional
.customSeasonalityValue(123)
.lowerBoundary(123)
.name("name")
.periodsBackward(123)
.periodsForward(123)
.predictionInterval(123)
.seasonality("seasonality")
.upperBoundary(123)
.value(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();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTemplate.ForecastComputationPropertystatic final classAn implementation forCfnTemplate.ForecastComputationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The ID for a computation.default NumberThe custom seasonality value setup of a forecast computation.default NumberThe lower boundary setup of a forecast computation.default StringgetName()The name of a computation.default NumberThe periods backward setup of a forecast computation.default NumberThe periods forward setup of a forecast computation.default NumberThe prediction interval setup of a forecast computation.default StringThe seasonality setup of a forecast computation.getTime()The time field that is used in a computation.default NumberThe upper boundary setup of a forecast computation.default ObjectgetValue()The value field that is used in a computation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComputationId
The ID for a computation. -
getTime
The time field that is used in a computation. -
getCustomSeasonalityValue
The custom seasonality value setup of a forecast computation. -
getLowerBoundary
The lower boundary setup of a forecast computation. -
getName
The name of a computation. -
getPeriodsBackward
The periods backward setup of a forecast computation. -
getPeriodsForward
The periods forward setup of a forecast computation. -
getPredictionInterval
The prediction interval setup of a forecast computation. -
getSeasonality
The seasonality setup of a forecast computation. Choose one of the following options:.AUTOMATICCUSTOM: Checks the custom seasonality value.
-
getUpperBoundary
The upper boundary setup of a forecast computation. -
getValue
The value field that is used in a computation. -
builder
-