Skip to content

ForecastComputation

Source code in docs_src/capo_quicksight/types/forecast_computation.py
class ForecastComputation(TypedDict, closed=True):
    computation_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID for a computation.</p>"""
    name: NotRequired["capo_quicksight.types.string.String"]
    """<p>The name of a computation.</p>"""
    time: NotRequired["capo_quicksight.types.dimension_field.DimensionField"]
    """<p>The time field that is used in a computation.</p>"""
    value: NotRequired["capo_quicksight.types.measure_field.MeasureField"]
    """<p>The value field that is used in a computation.</p>"""
    periods_forward: NotRequired["capo_quicksight.types.periods_forward.PeriodsForward"]
    """<p>The periods forward setup of a forecast computation.</p>"""
    periods_backward: NotRequired[
        "capo_quicksight.types.periods_backward.PeriodsBackward"
    ]
    """<p>The periods backward setup of a forecast computation.</p>"""
    upper_boundary: NotRequired["capo_quicksight.types.double.Double"]
    """<p>The upper boundary setup of a forecast computation.</p>"""
    lower_boundary: NotRequired["capo_quicksight.types.double.Double"]
    """<p>The lower boundary setup of a forecast computation.</p>"""
    prediction_interval: NotRequired[
        "capo_quicksight.types.prediction_interval.PredictionInterval"
    ]
    """<p>The prediction interval setup of a forecast computation.</p>"""
    seasonality: NotRequired[
        "capo_quicksight.types.forecast_computation_seasonality.ForecastComputationSeasonality"
    ]
    """<p>The seasonality setup of a forecast computation. Choose one of the following options:</p> <ul> <li> <p> <code>AUTOMATIC</code> </p> </li> <li> <p> <code>CUSTOM</code>: Checks the custom seasonality value.</p> </li> </ul>"""
    custom_seasonality_value: NotRequired[
        "capo_quicksight.types.forecast_computation_custom_seasonality_value.ForecastComputationCustomSeasonalityValue"
    ]
    """<p>The custom seasonality value setup of a forecast computation.</p>"""

computation_id instance-attribute

The ID for a computation.

custom_seasonality_value instance-attribute

custom_seasonality_value: NotRequired[ForecastComputationCustomSeasonalityValue]

The custom seasonality value setup of a forecast computation.

lower_boundary instance-attribute

lower_boundary: NotRequired[Double]

The lower boundary setup of a forecast computation.

name instance-attribute

name: NotRequired[String]

The name of a computation.

periods_backward instance-attribute

periods_backward: NotRequired[PeriodsBackward]

The periods backward setup of a forecast computation.

periods_forward instance-attribute

periods_forward: NotRequired[PeriodsForward]

The periods forward setup of a forecast computation.

prediction_interval instance-attribute

prediction_interval: NotRequired[PredictionInterval]

The prediction interval setup of a forecast computation.

seasonality instance-attribute

seasonality: NotRequired[ForecastComputationSeasonality]

The seasonality setup of a forecast computation. Choose one of the following options:

  • AUTOMATIC

  • CUSTOM: Checks the custom seasonality value.

time instance-attribute

time: NotRequired[DimensionField]

The time field that is used in a computation.

upper_boundary instance-attribute

upper_boundary: NotRequired[Double]

The upper boundary setup of a forecast computation.

value instance-attribute

value: NotRequired[MeasureField]

The value field that is used in a computation.