Class WorkloadEstimateSummary

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

Provides a summary of a workload estimate.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the workload estimate.

      Returns:
      The unique identifier of the workload estimate.

    • name

      public final String name()

      The name of the workload estimate.

      Returns:
      The name of the workload estimate.

    • createdAt

      public final Instant createdAt()

      The timestamp when the workload estimate was created.

      Returns:
      The timestamp when the workload estimate was created.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when the workload estimate will expire.

      Returns:
      The timestamp when the workload estimate will expire.

    • rateType

      public final WorkloadEstimateRateType rateType()

      The type of pricing rates used for the estimate.

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

      Returns:
      The type of pricing rates used for the estimate.
      See Also:

    • rateTypeAsString

      public final String rateTypeAsString()

      The type of pricing rates used for the estimate.

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

      Returns:
      The type of pricing rates used for the estimate.
      See Also:

    • rateTimestamp

      public final Instant rateTimestamp()

      The timestamp of the pricing rates used for the estimate.

      Returns:
      The timestamp of the pricing rates used for the estimate.

    • status

      public final WorkloadEstimateStatus status()

      The current status of the workload estimate.

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

      Returns:
      The current status of the workload estimate.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the workload estimate.

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

      Returns:
      The current status of the workload estimate.
      See Also:

    • totalCost

      public final Double totalCost()

      The total estimated cost for the workload.

      Returns:
      The total estimated cost for the workload.

    • costCurrency

      public final CurrencyCode costCurrency()

      The currency of the estimated cost.

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

      Returns:
      The currency of the estimated cost.
      See Also:

    • costCurrencyAsString

      public final String costCurrencyAsString()

      The currency of the estimated cost.

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

      Returns:
      The currency of the estimated cost.
      See Also:

    • failureMessage

      public final String failureMessage()

      An error message if the workload estimate creation or processing failed.

      Returns:
      An error message if the workload estimate creation or processing failed.

    • toBuilder

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

    • builder

      public static WorkloadEstimateSummary.Builder builder()

    • serializableBuilderClass

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