Class OutcomeBasedInvestment

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

An investment that is awarded upon completion of a defined outcome. This corresponds to the OUTCOME_BASED investment type and is claimed through CreateContractualInvestmentAttestation .

See Also:

  • Method Details

    • investmentId

      public final String investmentId()

      The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.

      Returns:
      The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.

    • outcomeDescription

      public final String outcomeDescription()

      The description of what must be completed to attest the outcome. This value is 1–2048 characters.

      Returns:
      The description of what must be completed to attest the outcome. This value is 1–2048 characters.

    • attestationWindow

      public final Interval attestationWindow()

      The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.

      Returns:
      The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.

    • hasInvestmentRestrictions

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

    • investmentRestrictions

      public final List<InvestmentRestriction> investmentRestrictions()

      The restrictions that cap the value that can be disbursed for the investment. 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 hasInvestmentRestrictions() method.

      Returns:
      The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.

    • hasInvestmentMultipliers

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

    • investmentMultipliers

      public final List<InvestmentMultiplier> investmentMultipliers()

      The multipliers used to compute the investment value from the attestation input. The list contains at most 200 multipliers. Multipliers are derived from the terms of the private pricing 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 hasInvestmentMultipliers() method.

      Returns:
      The multipliers used to compute the investment value from the attestation input. The list contains at most 200 multipliers. Multipliers are derived from the terms of the private pricing contract.

    • disbursedValue

      public final Amount disbursedValue()

      The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.

      Returns:
      The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.

    • toBuilder

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

    • builder

      public static OutcomeBasedInvestment.Builder builder()

    • serializableBuilderClass

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