Class AnalysisSummary

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

A summary of the analysis.

See Also:

  • Method Details

    • estimatedCompletionTime

      public final String estimatedCompletionTime()

      The estimated time for when the analysis will complete.

      Returns:
      The estimated time for when the analysis will complete.

    • analysisCompletionTime

      public final String analysisCompletionTime()

      The completion time of the analysis.

      Returns:
      The completion time of the analysis.

    • analysisStartedTime

      public final String analysisStartedTime()

      The start time of the analysis.

      Returns:
      The start time of the analysis.

    • analysisStatus

      public final AnalysisStatus analysisStatus()

      The status of the analysis.

      If the service returns an enum value that is not available in the current SDK version, analysisStatus will return AnalysisStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisStatusAsString().

      Returns:
      The status of the analysis.
      See Also:

    • analysisStatusAsString

      public final String analysisStatusAsString()

      The status of the analysis.

      If the service returns an enum value that is not available in the current SDK version, analysisStatus will return AnalysisStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisStatusAsString().

      Returns:
      The status of the analysis.
      See Also:

    • errorCode

      public final ErrorCode errorCode()

      The error code used for the analysis.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      The error code used for the analysis.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      The error code used for the analysis.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      The error code used for the analysis.
      See Also:

    • analysisId

      public final String analysisId()

      The analysis ID that's associated with the commitment purchase analysis.

      Returns:
      The analysis ID that's associated with the commitment purchase analysis.

    • commitmentPurchaseAnalysisConfiguration

      public final CommitmentPurchaseAnalysisConfiguration commitmentPurchaseAnalysisConfiguration()

      The configuration for the commitment purchase analysis.

      Returns:
      The configuration for the commitment purchase analysis.

    • toBuilder

      public AnalysisSummary.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<AnalysisSummary.Builder,AnalysisSummary>
      Returns:
      a builder for type T

    • builder

      public static AnalysisSummary.Builder builder()

    • serializableBuilderClass

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