Interface OutcomeBasedInvestment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OutcomeBasedInvestment.Builder,OutcomeBasedInvestment>, SdkBuilder<OutcomeBasedInvestment.Builder,OutcomeBasedInvestment>, SdkPojo
Enclosing class:
OutcomeBasedInvestment
@Mutable @NotThreadSafe public static interface OutcomeBasedInvestment.Builder extends SdkPojo, CopyableBuilder<OutcomeBasedInvestment.Builder,OutcomeBasedInvestment>

  • Method Details

    • investmentId

      OutcomeBasedInvestment.Builder investmentId(String investmentId)

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

      Parameters:
      investmentId - The identifier of the investment, as returned by ListContractualInvestments. This value is 1–36 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outcomeDescription

      OutcomeBasedInvestment.Builder outcomeDescription(String outcomeDescription)

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

      Parameters:
      outcomeDescription - The description of what must be completed to attest the outcome. This value is 1–2048 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestationWindow

      OutcomeBasedInvestment.Builder attestationWindow(Interval attestationWindow)

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

      Parameters:
      attestationWindow - The time window, expressed as an interval with inclusive start and end dates, during which outcomes can be attested to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestationWindow

      default OutcomeBasedInvestment.Builder attestationWindow(Consumer<Interval.Builder> attestationWindow)

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

      This is a convenience method that creates an instance of the Interval.Builder avoiding the need to create one manually via Interval.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attestationWindow(Interval).

      Parameters:
      attestationWindow - a consumer that will call methods on Interval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • investmentRestrictions

      OutcomeBasedInvestment.Builder investmentRestrictions(Collection<InvestmentRestriction> investmentRestrictions)

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

      Parameters:
      investmentRestrictions - The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentRestrictions

      OutcomeBasedInvestment.Builder investmentRestrictions(InvestmentRestriction... investmentRestrictions)

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

      Parameters:
      investmentRestrictions - The restrictions that cap the value that can be disbursed for the investment. The list contains at most 10 restrictions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentRestrictions

      OutcomeBasedInvestment.Builder investmentRestrictions(Consumer<InvestmentRestriction.Builder>... investmentRestrictions)

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

      This is a convenience method that creates an instance of the InvestmentRestriction.Builder avoiding the need to create one manually via InvestmentRestriction.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to investmentRestrictions(List<InvestmentRestriction>).

      Parameters:
      investmentRestrictions - a consumer that will call methods on InvestmentRestriction.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • investmentMultipliers

      OutcomeBasedInvestment.Builder investmentMultipliers(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentMultipliers

      OutcomeBasedInvestment.Builder investmentMultipliers(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentMultipliers

      OutcomeBasedInvestment.Builder investmentMultipliers(Consumer<InvestmentMultiplier.Builder>... 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.

      This is a convenience method that creates an instance of the InvestmentMultiplier.Builder avoiding the need to create one manually via InvestmentMultiplier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to investmentMultipliers(List<InvestmentMultiplier>).

      Parameters:
      investmentMultipliers - a consumer that will call methods on InvestmentMultiplier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disbursedValue

      OutcomeBasedInvestment.Builder disbursedValue(Amount disbursedValue)

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

      Parameters:
      disbursedValue - The total value already disbursed against the investment. This value can be distributed among the investment accounts distribution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disbursedValue

      default OutcomeBasedInvestment.Builder disbursedValue(Consumer<Amount.Builder> disbursedValue)

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

      This is a convenience method that creates an instance of the Amount.Builder avoiding the need to create one manually via Amount.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to disbursedValue(Amount).

      Parameters:
      disbursedValue - a consumer that will call methods on Amount.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: