Class CreateBillEstimateResponse

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

  • Method Details

    • id

      public final String id()

      The unique identifier of your newly created Bill estimate.

      Returns:
      The unique identifier of your newly created Bill estimate.

    • name

      public final String name()

      The name of your newly created Bill estimate.

      Returns:
      The name of your newly created Bill estimate.

    • status

      public final BillEstimateStatus status()

      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

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

      Returns:
      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

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

      Returns:
      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
      See Also:

    • failureMessage

      public final String failureMessage()

      This attribute provides the reason if a Bill estimate result generation fails.

      Returns:
      This attribute provides the reason if a Bill estimate result generation fails.

    • billInterval

      public final BillInterval billInterval()

      The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

      Returns:
      The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

    • costSummary

      public final BillEstimateCostSummary costSummary()

      Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

      Returns:
      Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

      Returns:
      The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

    • expiresAt

      public final Instant expiresAt()

      The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

      Returns:
      The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

    • toBuilder

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

    • builder

      public static CreateBillEstimateResponse.Builder builder()

    • serializableBuilderClass

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