Class ForecastComputation
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.ForecastComputation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>
@Generated("software.amazon.awssdk:codegen") public final class ForecastComputation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>
The forecast computation configuration.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceForecastComputation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ForecastComputation.Builderbuilder()StringcomputationId()The ID for a computation.IntegercustomSeasonalityValue()The custom seasonality value setup of a forecast computation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()DoublelowerBoundary()The lower boundary setup of a forecast computation.Stringname()The name of a computation.IntegerperiodsBackward()The periods backward setup of a forecast computation.IntegerperiodsForward()The periods forward setup of a forecast computation.IntegerpredictionInterval()The prediction interval setup of a forecast computation.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()ForecastComputationSeasonalityseasonality()The seasonality setup of a forecast computation.StringseasonalityAsString()The seasonality setup of a forecast computation.static Class<? extends ForecastComputation.Builder>serializableBuilderClass()DimensionFieldtime()The time field that is used in a computation.ForecastComputation.BuildertoBuilder()StringtoString()Returns a string representation of this object.DoubleupperBoundary()The upper boundary setup of a forecast computation.MeasureFieldvalue()The value field that is used in a computation.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
computationId
public final String computationId()
The ID for a computation.
- Returns:
- The ID for a computation.
-
name
public final String name()
The name of a computation.
- Returns:
- The name of a computation.
-
time
public final DimensionField time()
The time field that is used in a computation.
- Returns:
- The time field that is used in a computation.
-
value
public final MeasureField value()
The value field that is used in a computation.
- Returns:
- The value field that is used in a computation.
-
periodsForward
public final Integer periodsForward()
The periods forward setup of a forecast computation.
- Returns:
- The periods forward setup of a forecast computation.
-
periodsBackward
public final Integer periodsBackward()
The periods backward setup of a forecast computation.
- Returns:
- The periods backward setup of a forecast computation.
-
upperBoundary
public final Double upperBoundary()
The upper boundary setup of a forecast computation.
- Returns:
- The upper boundary setup of a forecast computation.
-
lowerBoundary
public final Double lowerBoundary()
The lower boundary setup of a forecast computation.
- Returns:
- The lower boundary setup of a forecast computation.
-
predictionInterval
public final Integer predictionInterval()
The prediction interval setup of a forecast computation.
- Returns:
- The prediction interval setup of a forecast computation.
-
seasonality
public final ForecastComputationSeasonality seasonality()
The seasonality setup of a forecast computation. Choose one of the following options:
-
AUTOMATIC -
CUSTOM: Checks the custom seasonality value.
If the service returns an enum value that is not available in the current SDK version,
seasonalitywill returnForecastComputationSeasonality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromseasonalityAsString().- Returns:
- The seasonality setup of a forecast computation. Choose one of the following options:
-
AUTOMATIC -
CUSTOM: Checks the custom seasonality value.
-
- See Also:
ForecastComputationSeasonality
-
-
seasonalityAsString
public final String seasonalityAsString()
The seasonality setup of a forecast computation. Choose one of the following options:
-
AUTOMATIC -
CUSTOM: Checks the custom seasonality value.
If the service returns an enum value that is not available in the current SDK version,
seasonalitywill returnForecastComputationSeasonality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromseasonalityAsString().- Returns:
- The seasonality setup of a forecast computation. Choose one of the following options:
-
AUTOMATIC -
CUSTOM: Checks the custom seasonality value.
-
- See Also:
ForecastComputationSeasonality
-
-
customSeasonalityValue
public final Integer customSeasonalityValue()
The custom seasonality value setup of a forecast computation.
- Returns:
- The custom seasonality value setup of a forecast computation.
-
toBuilder
public ForecastComputation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>
-
builder
public static ForecastComputation.Builder builder()
-
serializableBuilderClass
public static Class<? extends ForecastComputation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-