Class ForecastSummary

java.lang.Object
software.amazon.awssdk.services.forecast.model.ForecastSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ForecastSummary.Builder,ForecastSummary>
@Generated("software.amazon.awssdk:codegen") public final class ForecastSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ForecastSummary.Builder,ForecastSummary>

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

See Also:

  • Method Details

    • forecastArn

      public final String forecastArn()

      The ARN of the forecast.

      Returns:
      The ARN of the forecast.

    • forecastName

      public final String forecastName()

      The name of the forecast.

      Returns:
      The name of the forecast.

    • predictorArn

      public final String predictorArn()

      The ARN of the predictor used to generate the forecast.

      Returns:
      The ARN of the predictor used to generate the forecast.

    • createdUsingAutoPredictor

      public final Boolean createdUsingAutoPredictor()

      Whether the Forecast was created from an AutoPredictor.

      Returns:
      Whether the Forecast was created from an AutoPredictor.

    • datasetGroupArn

      public final String datasetGroupArn()

      The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

      Returns:
      The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

    • status

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

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

    • 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 forecast creation task was created.

      Returns:
      When the forecast creation task 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.

    • toBuilder

      public ForecastSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ForecastSummary.Builder,ForecastSummary>
      Returns:
      a builder for type T

    • builder

      public static ForecastSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ForecastSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.