Class GetEnterpriseSupportContractDetailsResponse

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

The response structure for GetEnterpriseSupportContractDetails.

  • Method Details

    • isContractActive

      public final Boolean isContractActive()

      When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.

      Returns:
      When true, the Enterprise Support contract is active. When false, the Enterprise Support Contract is inactive.

    • supportAllocationMethod

      public final String supportAllocationMethod()

      The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract.

      Returns:
      The method used to distribute the total Support charge amount across each account in the Support profile. Valid values: Proportional, Fixed_Percentage. Proportional means support charges are distributed to each account in proportion to its eligible Spend. Fixed_Percentage means support charges are distributed across accounts according to pre-configured percentages from the contract.

    • supportReservedInstanceAmortizationStartDate

      public final Instant supportReservedInstanceAmortizationStartDate()

      When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods.

      Returns:
      When supportReservedInstanceTreatmentMethod = AmortizedCustom, only amortized fees for Reserved Instances purchased on or after this date are included in the calculation. This field is Null for all other treatment methods.

    • supportReservedInstanceTreatmentMethod

      public final String supportReservedInstanceTreatmentMethod()

      The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started).

      Returns:
      The method used to include Reserved Instance (RI) fees in the Enterprise Support charge calculation. Valid values: None (RI fees excluded from Support-eligible spend), Upfront (full upfront RI fees included in month of purchase), Amortized (RI fees spread over commitment term for RIs purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for RIs purchased on or after a specified custom start date), AmortizedAll (RI fees amortized for all active RIs including those purchased before Support subscription started).

    • supportSavingsPlansAmortizationStartDate

      public final Instant supportSavingsPlansAmortizationStartDate()

      This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend.

      Returns:
      This is applicable when supportSavingsPlansTreatmentMethod = Amortized and is Null for all other methods. It shows the start date from which Savings Plan fees are included in Support Eligible Spend.

    • supportSavingsPlansTreatmentMethod

      public final String supportSavingsPlansTreatmentMethod()

      The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started).

      Returns:
      The method used to include Savings Plans fees in Enterprise Support charge calculations. Valid values: None (Savings Plan fees excluded from Support-eligible spend), Upfront (full upfront Savings Plan fees included in month of purchase), Amortized (Savings Plan fees spread over commitment term for Savings Plans purchased on or after Support subscription start date), AmortizedCustom (same as Amortized but only for Savings Plans purchased on or after a specified custom start date), AmortizedAll (Savings Plan fees amortized for all active Savings Plans including those purchased before Support subscription started).

    • supportProrateStartDate

      public final Instant supportProrateStartDate()

      The start date for accounts subscribed or unsubscribed to Support billing during the billing month.

      Returns:
      The start date for accounts subscribed or unsubscribed to Support billing during the billing month.

    • hasContractPayerAccountIds

      public final boolean hasContractPayerAccountIds()
      For responses, this returns true if the service returned a value for the ContractPayerAccountIds 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.

    • contractPayerAccountIds

      public final List<ContractAccount> contractPayerAccountIds()

      The list of accounts covered by the Enterprise Support contract.

      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 hasContractPayerAccountIds() method.

      Returns:
      The list of accounts covered by the Enterprise Support contract.

    • hasChargedPayerAccountIds

      public final boolean hasChargedPayerAccountIds()
      For responses, this returns true if the service returned a value for the ChargedPayerAccountIds 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.

    • chargedPayerAccountIds

      public final List<ChargeAccount> chargedPayerAccountIds()

      The list of payer accounts and their charge allocation percentages.

      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 hasChargedPayerAccountIds() method.

      Returns:
      The list of payer accounts and their charge allocation percentages.

    • hasAdditionalSupportCharge

      public final boolean hasAdditionalSupportCharge()
      For responses, this returns true if the service returned a value for the AdditionalSupportCharge 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.

    • additionalSupportCharge

      public final List<AdditionalCharge> additionalSupportCharge()

      Any Additional support charges applied to the contract.

      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 hasAdditionalSupportCharge() method.

      Returns:
      Any Additional support charges applied to the contract.

    • hasAdditionalSupportEligibleUsageSpend

      public final boolean hasAdditionalSupportEligibleUsageSpend()
      For responses, this returns true if the service returned a value for the AdditionalSupportEligibleUsageSpend 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.

    • additionalSupportEligibleUsageSpend

      public final List<AdditionalCharge> additionalSupportEligibleUsageSpend()

      Any Additional support-eligible usage spend charges.

      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 hasAdditionalSupportEligibleUsageSpend() method.

      Returns:
      Any Additional support-eligible usage spend charges.

    • hasPricingPlans

      public final boolean hasPricingPlans()
      For responses, this returns true if the service returned a value for the PricingPlans 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.

    • pricingPlans

      public final List<PricingPlan> pricingPlans()

      The pricing plans associated with this Enterprise Support contract.

      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 hasPricingPlans() method.

      Returns:
      The pricing plans associated with this Enterprise Support contract.

    • toBuilder

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

    • builder

      public static GetEnterpriseSupportContractDetailsResponse.Builder builder()

    • serializableBuilderClass

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