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

Class DescribeWhatIfForecastResponse

    • Method Detail

      • whatIfForecastName

        public final String whatIfForecastName()

        The name of the what-if forecast.

        Returns:
        The name of the what-if forecast.

      • whatIfForecastArn

        public final String whatIfForecastArn()

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

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

      • whatIfAnalysisArn

        public final String whatIfAnalysisArn()

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

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

      • estimatedTimeRemainingInMinutes

        public final Long estimatedTimeRemainingInMinutes()

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

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

      • status

        public final 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.

        Returns:
        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.

      • message

        public final String message()

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

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

      • creationTime

        public final Instant creationTime()

        When the what-if forecast was created.

        Returns:
        When the what-if forecast was created.

      • lastModificationTime

        public final 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.

        Returns:
        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.

      • hasTimeSeriesTransformations

        public final boolean hasTimeSeriesTransformations()
        For responses, this returns true if the service returned a value for the TimeSeriesTransformations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • timeSeriesTransformations

        public final List<TimeSeriesTransformation> timeSeriesTransformations()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTimeSeriesTransformations() method.

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

      • timeSeriesReplacementsDataSource

        public final TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource()

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

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

      • hasForecastTypes

        public final boolean hasForecastTypes()
        For responses, this returns true if the service returned a value for the ForecastTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • forecastTypes

        public final List<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"].

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastTypes() method.

        Returns:
        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"].

      • 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.
        Overrides:
        toString in class Object