Class PrivatePricingAddendum

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

The details of a private pricing addendum contract.

See Also:

  • Method Details

    • contractArn

      public final String contractArn()

      The Amazon Resource Name (ARN) of the private pricing addendum.

      Returns:
      The Amazon Resource Name (ARN) of the private pricing addendum.

    • contractTerm

      public final Interval contractTerm()

      The contract term period of the private pricing addendum, expressed as an interval with an inclusive start date and an inclusive end date.

      Returns:
      The contract term period of the private pricing addendum, expressed as an interval with an inclusive start date and an inclusive end date.

    • hasEligiblePayerAccounts

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

    • eligiblePayerAccounts

      public final List<String> eligiblePayerAccounts()

      The payer accounts that are eligible under the private pricing addendum. The list contains at most 100 account IDs.

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

      Returns:
      The payer accounts that are eligible under the private pricing addendum. The list contains at most 100 account IDs.

    • hasInvestmentAccounts

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

    • investmentAccounts

      public final List<String> investmentAccounts()

      The accounts that are eligible to receive investments under the private pricing addendum. An InvestmentDistribution must target one of these accounts. The list contains at most 100 account IDs.

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

      Returns:
      The accounts that are eligible to receive investments under the private pricing addendum. An InvestmentDistribution must target one of these accounts. The list contains at most 100 account IDs.

    • hasLegalEntities

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

    • legalEntities

      public final List<LegalEntity> legalEntities()

      The legal entities on the private pricing addendum. The list contains at most 10 legal entities.

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

      Returns:
      The legal entities on the private pricing addendum. The list contains at most 10 legal entities.

    • contractRestrictions

      public final List<ContractRestriction> contractRestrictions()

      The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.

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

      Returns:
      The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.

    • hasContractRestrictions

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

    • contractRestrictionsAsStrings

      public final List<String> contractRestrictionsAsStrings()

      The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.

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

      Returns:
      The restrictions that limit the self-service actions you can take on the private pricing addendum. An empty or absent value indicates that no restrictions apply. The list contains at most 10 restrictions.

    • toBuilder

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

    • builder

      public static PrivatePricingAddendum.Builder builder()

    • serializableBuilderClass

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