Class BillScenarioSummary

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

Provides a summary of a bill scenario.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the bill scenario.

      Returns:
      The unique identifier of the bill scenario.

    • name

      public final String name()

      The name of the bill scenario.

      Returns:
      The name of the bill scenario.

    • billInterval

      public final BillInterval billInterval()

      The time period covered by the bill scenario.

      Returns:
      The time period covered by the bill scenario.

    • status

      public final BillScenarioStatus status()

      The current status of the bill scenario.

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

      Returns:
      The current status of the bill scenario.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the bill scenario.

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

      Returns:
      The current status of the bill scenario.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the bill scenario was created.

      Returns:
      The timestamp when the bill scenario was created.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when the bill scenario will expire.

      Returns:
      The timestamp when the bill scenario will expire.

    • failureMessage

      public final String failureMessage()

      An error message if the bill scenario creation or processing failed.

      Returns:
      An error message if the bill scenario creation or processing failed.

    • toBuilder

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

    • builder

      public static BillScenarioSummary.Builder builder()

    • serializableBuilderClass

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