Package software.amazon.awssdk.services.forecast.model

Interface DescribeWhatIfForecastResponse.Builder

    • Method Detail

      • whatIfForecastName

        DescribeWhatIfForecastResponse.Builder whatIfForecastName​(String whatIfForecastName)

        The name of the what-if forecast.

        Parameters:
        whatIfForecastName - The name of the what-if forecast.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • whatIfForecastArn

        DescribeWhatIfForecastResponse.Builder whatIfForecastArn​(String whatIfForecastArn)

        The Amazon Resource Name (ARN) of the what-if forecast.

        Parameters:
        whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • whatIfAnalysisArn

        DescribeWhatIfForecastResponse.Builder whatIfAnalysisArn​(String whatIfAnalysisArn)

        The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

        Parameters:
        whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • estimatedTimeRemainingInMinutes

        DescribeWhatIfForecastResponse.Builder estimatedTimeRemainingInMinutes​(Long estimatedTimeRemainingInMinutes)

        The approximate time remaining to complete the what-if forecast, in minutes.

        Parameters:
        estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if forecast, in minutes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        DescribeWhatIfForecastResponse.Builder status​(String status)

        The status of the what-if forecast. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        The Status of the what-if forecast must be ACTIVE before you can access the forecast.

        Parameters:
        status - The status of the what-if forecast. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        The Status of the what-if forecast must be ACTIVE before you can access the forecast.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • message

        DescribeWhatIfForecastResponse.Builder message​(String message)

        If an error occurred, an informational message about the error.

        Parameters:
        message - If an error occurred, an informational message about the error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        DescribeWhatIfForecastResponse.Builder creationTime​(Instant creationTime)

        When the what-if forecast was created.

        Parameters:
        creationTime - When the what-if forecast was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModificationTime

        DescribeWhatIfForecastResponse.Builder lastModificationTime​(Instant lastModificationTime)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

        Parameters:
        lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeSeriesTransformations

        DescribeWhatIfForecastResponse.Builder timeSeriesTransformations​(Collection<TimeSeriesTransformation> timeSeriesTransformations)

        An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

        Parameters:
        timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeSeriesTransformations

        DescribeWhatIfForecastResponse.Builder timeSeriesTransformations​(TimeSeriesTransformation... timeSeriesTransformations)

        An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

        Parameters:
        timeSeriesTransformations - An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeSeriesReplacementsDataSource

        DescribeWhatIfForecastResponse.Builder timeSeriesReplacementsDataSource​(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)

        An array of S3Config, Schema, and Format elements that describe the replacement time series.

        Parameters:
        timeSeriesReplacementsDataSource - An array of S3Config, Schema, and Format elements that describe the replacement time series.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forecastTypes

        DescribeWhatIfForecastResponse.Builder forecastTypes​(Collection<String> forecastTypes)

        The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

        Parameters:
        forecastTypes - The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forecastTypes

        DescribeWhatIfForecastResponse.Builder forecastTypes​(String... forecastTypes)

        The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

        Parameters:
        forecastTypes - The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
        Returns:
        Returns a reference to this object so that method calls can be chained together.