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

Interface DescribeWhatIfForecastExportResponse.Builder

    • Method Detail

      • whatIfForecastExportArn

        DescribeWhatIfForecastExportResponse.Builder whatIfForecastExportArn​(String whatIfForecastExportArn)

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

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

      • whatIfForecastExportName

        DescribeWhatIfForecastExportResponse.Builder whatIfForecastExportName​(String whatIfForecastExportName)

        The name of the what-if forecast export.

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

      • whatIfForecastArns

        DescribeWhatIfForecastExportResponse.Builder whatIfForecastArns​(Collection<String> whatIfForecastArns)

        An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

        Parameters:
        whatIfForecastArns - An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • whatIfForecastArns

        DescribeWhatIfForecastExportResponse.Builder whatIfForecastArns​(String... whatIfForecastArns)

        An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

        Parameters:
        whatIfForecastArns - An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destination

        DescribeWhatIfForecastExportResponse.Builder destination​(DataDestination destination)
        Sets the value of the Destination property for this object.
        Parameters:
        destination - The new value for the Destination property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • message

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

      • status

        DescribeWhatIfForecastExportResponse.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 export must be ACTIVE before you can access the forecast export.

        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 export must be ACTIVE before you can access the forecast export.

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

      • creationTime

        DescribeWhatIfForecastExportResponse.Builder creationTime​(Instant creationTime)

        When the what-if forecast export was created.

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

      • estimatedTimeRemainingInMinutes

        DescribeWhatIfForecastExportResponse.Builder estimatedTimeRemainingInMinutes​(Long estimatedTimeRemainingInMinutes)

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

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

      • lastModificationTime

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

      • format

        DescribeWhatIfForecastExportResponse.Builder format​(String format)

        The format of the exported data, CSV or PARQUET.

        Parameters:
        format - The format of the exported data, CSV or PARQUET.
        Returns:
        Returns a reference to this object so that method calls can be chained together.