Class WhatIfAnalysisSummary

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

Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is listed in the summary.

See Also:

  • Method Details

    • whatIfAnalysisArn

      public final String whatIfAnalysisArn()

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

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

    • whatIfAnalysisName

      public final String whatIfAnalysisName()

      The name of the what-if analysis.

      Returns:
      The name of the what-if analysis.

    • forecastArn

      public final String forecastArn()

      The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

      Returns:
      The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

    • status

      public final String status()

      The status of the what-if analysis. 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 analysis must be ACTIVE before you can access the analysis.

      Returns:
      The status of the what-if analysis. 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 analysis must be ACTIVE before you can access the analysis.

    • 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 analysis was created.

      Returns:
      When the what-if analysis 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 WhatIfAnalysisSummary.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<WhatIfAnalysisSummary.Builder,WhatIfAnalysisSummary>
      Returns:
      a builder for type T

    • builder

      public static WhatIfAnalysisSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WhatIfAnalysisSummary.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.