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

Interface DescribeForecastResponse.Builder

    • Method Detail

      • forecastArn

        DescribeForecastResponse.Builder forecastArn​(String forecastArn)

        The forecast ARN as specified in the request.

        Parameters:
        forecastArn - The forecast ARN as specified in the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forecastName

        DescribeForecastResponse.Builder forecastName​(String forecastName)

        The name of the forecast.

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

      • forecastTypes

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

        The quantiles at which probabilistic forecasts were generated.

        Parameters:
        forecastTypes - The quantiles at which probabilistic forecasts were generated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • forecastTypes

        DescribeForecastResponse.Builder forecastTypes​(String... forecastTypes)

        The quantiles at which probabilistic forecasts were generated.

        Parameters:
        forecastTypes - The quantiles at which probabilistic forecasts were generated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • predictorArn

        DescribeForecastResponse.Builder predictorArn​(String predictorArn)

        The ARN of the predictor used to generate the forecast.

        Parameters:
        predictorArn - The ARN of the predictor used to generate the forecast.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetGroupArn

        DescribeForecastResponse.Builder datasetGroupArn​(String datasetGroupArn)

        The ARN of the dataset group that provided the data used to train the predictor.

        Parameters:
        datasetGroupArn - The ARN of the dataset group that provided the data used to train the predictor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • estimatedTimeRemainingInMinutes

        DescribeForecastResponse.Builder estimatedTimeRemainingInMinutes​(Long estimatedTimeRemainingInMinutes)

        The estimated time remaining in minutes for the forecast job to complete.

        Parameters:
        estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the forecast job to complete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        DescribeForecastResponse.Builder status​(String status)

        The status of the 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 forecast must be ACTIVE before you can query or export the forecast.

        Parameters:
        status - The status of the 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 forecast must be ACTIVE before you can query or export the forecast.

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

      • message

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

        DescribeForecastResponse.Builder creationTime​(Instant creationTime)

        When the forecast creation task was created.

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

      • lastModificationTime

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

      • timeSeriesSelector

        DescribeForecastResponse.Builder timeSeriesSelector​(TimeSeriesSelector timeSeriesSelector)

        The time series to include in the forecast.

        Parameters:
        timeSeriesSelector - The time series to include in the forecast.
        Returns:
        Returns a reference to this object so that method calls can be chained together.