Class AwsProductInsights

java.lang.Object
software.amazon.awssdk.services.partnercentralselling.model.AwsProductInsights
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsProductInsights.Builder,AwsProductInsights>

@Generated("software.amazon.awssdk:codegen") public final class AwsProductInsights extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsProductInsights.Builder,AwsProductInsights>

Comprehensive spend analysis for a single source (AWS or Partner) including total amounts, optimization savings, program category breakdowns, and detailed product-level insights.

See Also:
  • Method Details

    • currencyCode

      public final AwsProductInsightsCurrencyCodeEnum currencyCode()

      ISO 4217 currency code (e.g., "USD") ensuring consistent representation across calculations

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

      Returns:
      ISO 4217 currency code (e.g., "USD") ensuring consistent representation across calculations
      See Also:
    • currencyCodeAsString

      public final String currencyCodeAsString()

      ISO 4217 currency code (e.g., "USD") ensuring consistent representation across calculations

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

      Returns:
      ISO 4217 currency code (e.g., "USD") ensuring consistent representation across calculations
      See Also:
    • frequency

      public final PaymentFrequency frequency()

      Time period for spend amounts: "Monthly" or "Annually"

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

      Returns:
      Time period for spend amounts: "Monthly" or "Annually"
      See Also:
    • frequencyAsString

      public final String frequencyAsString()

      Time period for spend amounts: "Monthly" or "Annually"

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

      Returns:
      Time period for spend amounts: "Monthly" or "Annually"
      See Also:
    • totalAmount

      public final String totalAmount()

      Total estimated spend for this source before optimizations

      Returns:
      Total estimated spend for this source before optimizations
    • totalOptimizedAmount

      public final String totalOptimizedAmount()

      Total estimated spend after applying recommended optimizations

      Returns:
      Total estimated spend after applying recommended optimizations
    • totalPotentialSavingsAmount

      public final String totalPotentialSavingsAmount()

      Quantified savings achievable through implementing optimizations

      Returns:
      Quantified savings achievable through implementing optimizations
    • hasTotalAmountByCategory

      public final boolean hasTotalAmountByCategory()
      For responses, this returns true if the service returned a value for the TotalAmountByCategory property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • totalAmountByCategory

      public final Map<String,String> totalAmountByCategory()

      Spend amounts mapped to AWS programs and modernization pathways

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTotalAmountByCategory() method.

      Returns:
      Spend amounts mapped to AWS programs and modernization pathways
    • hasAwsProducts

      public final boolean hasAwsProducts()
      For responses, this returns true if the service returned a value for the AwsProducts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • awsProducts

      public final List<AwsProductDetails> awsProducts()

      Product-level details including costs and optimization recommendations

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAwsProducts() method.

      Returns:
      Product-level details including costs and optimization recommendations
    • toBuilder

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

      public static AwsProductInsights.Builder builder()
    • serializableBuilderClass

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