Class InvestmentSummary

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

Detailed information about an investment summary within a contract or a private pricing addendum.

See Also:

  • Method Details

    • investmentSummaryId

      public final String investmentSummaryId()

      The identifier of the investment summary. Pass this value to ListContractualInvestments to list the investments within the summary, and to CreateContractualInvestmentAttestation to attest an investment. This value is 1–36 characters.

      Returns:
      The identifier of the investment summary. Pass this value to ListContractualInvestments to list the investments within the summary, and to CreateContractualInvestmentAttestation to attest an investment. This value is 1–36 characters.

    • investmentName

      public final String investmentName()

      The name of the investment summary, used to reference the investment against a term in the physical contract. This value is 1–400 characters.

      Returns:
      The name of the investment summary, used to reference the investment against a term in the physical contract. This value is 1–400 characters.

    • investmentType

      public final InvestmentType investmentType()

      The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.

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

      Returns:
      The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.
      See Also:

    • investmentTypeAsString

      public final String investmentTypeAsString()

      The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.

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

      Returns:
      The type of the investment summary. Valid values are MILESTONE_BASED and OUTCOME_BASED. OUTCOME_BASED investments can be attested to, upon completion of outcomes. MILESTONE_BASED are automatically triggered by Amazon Web Services, based on the time schedule in the contract.
      See Also:

    • maxAllowedInvestmentDisbursementValue

      public final Amount maxAllowedInvestmentDisbursementValue()

      The maximum monetary value that can be disbursed against the investment summary, inclusive of all outcomes combined under the summary.

      Returns:
      The maximum monetary value that can be disbursed against the investment summary, inclusive of all outcomes combined under the summary.

    • toBuilder

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

    • builder

      public static InvestmentSummary.Builder builder()

    • serializableBuilderClass

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