Class DescribeForecastResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.forecast.model.ForecastResponse
software.amazon.awssdk.services.forecast.model.DescribeForecastResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeForecastResponse.Builder,DescribeForecastResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeForecastResponse extends ForecastResponse implements ToCopyableBuilder<DescribeForecastResponse.Builder,DescribeForecastResponse>

  • Method Details

    • forecastArn

      public final String forecastArn()

      The forecast ARN as specified in the request.

      Returns:
      The forecast ARN as specified in the request.

    • forecastName

      public final String forecastName()

      The name of the forecast.

      Returns:
      The name of the forecast.

    • 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 were generated.

      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 were generated.

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

    • datasetGroupArn

      public final String datasetGroupArn()

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

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

    • estimatedTimeRemainingInMinutes

      public final Long estimatedTimeRemainingInMinutes()

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

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

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

    • timeSeriesSelector

      public final TimeSeriesSelector timeSeriesSelector()

      The time series to include in the forecast.

      Returns:
      The time series to include in the forecast.

    • toBuilder

      public DescribeForecastResponse.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<DescribeForecastResponse.Builder,DescribeForecastResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeForecastResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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