Class InvestmentAttestation

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

A summary of a submitted investment attestation, as returned by ListContractualInvestmentAttestations.

See Also:

  • Method Details

    • attestationId

      public final String attestationId()

      The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.

      Returns:
      The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.

    • investmentName

      public final String investmentName()

      The name of the investment summary that contains the attested outcome. This value is 1–400 characters.

      Returns:
      The name of the investment summary that contains the attested outcome. This value is 1–400 characters.

    • outcomeDescription

      public final String outcomeDescription()

      The description of the attested outcome. This value is 1–2048 characters.

      Returns:
      The description of the attested outcome. This value is 1–2048 characters.

    • investmentSummaryId

      public final String investmentSummaryId()

      The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.

      Returns:
      The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.

    • investmentId

      public final String investmentId()

      The identifier of the investment that was attested, as returned by ListContractualInvestments.

      Returns:
      The identifier of the investment that was attested, as returned by ListContractualInvestments.

    • attestedAt

      public final Instant attestedAt()

      The date on which the attestation was submitted.

      Returns:
      The date on which the attestation was submitted.

    • updatedAt

      public final Instant updatedAt()

      The date on which the attestation was last updated.

      Returns:
      The date on which the attestation was last updated.

    • attestationStatus

      public final InvestmentAttestationStatus attestationStatus()

      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.

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

      Returns:
      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.
      See Also:

    • attestationStatusAsString

      public final String attestationStatusAsString()

      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.

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

      Returns:
      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.
      See Also:

    • investmentDisbursedAt

      public final Instant investmentDisbursedAt()

      The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.

      Returns:
      The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.

    • attestedValue

      public final Amount attestedValue()

      The monetary value attested.

      Returns:
      The monetary value attested.

    • hasInvestmentDistributions

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

    • investmentDistributions

      public final List<InvestmentDistribution> investmentDistributions()

      The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

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

      Returns:
      The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

    • hasRejectionReasons

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

    • rejectionReasons

      public final List<String> rejectionReasons()

      The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.

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

      Returns:
      The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.

    • isCancellable

      public final Boolean isCancellable()

      Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.

      Returns:
      Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.

    • toBuilder

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

    • builder

      public static InvestmentAttestation.Builder builder()

    • serializableBuilderClass

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