Interface Proposal.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Proposal.Builder,Proposal>, SdkBuilder<Proposal.Builder,Proposal>, SdkPojo
Enclosing class:
Proposal
public static interface Proposal.Builder extends SdkPojo, CopyableBuilder<Proposal.Builder,Proposal>

  • Method Details

    • proposalId

      Proposal.Builder proposalId(String proposalId)

      The unique identifier of the proposal.

      Parameters:
      proposalId - The unique identifier of the proposal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkId

      Proposal.Builder networkId(String networkId)

      The unique identifier of the network for which the proposal is made.

      Parameters:
      networkId - The unique identifier of the network for which the proposal is made.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Proposal.Builder description(String description)

      The description of the proposal.

      Parameters:
      description - The description of the proposal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      Proposal.Builder actions(ProposalActions actions)

      The actions to perform on the network if the proposal is APPROVED.

      Parameters:
      actions - The actions to perform on the network if the proposal is APPROVED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      default Proposal.Builder actions(Consumer<ProposalActions.Builder> actions)

      The actions to perform on the network if the proposal is APPROVED.

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

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

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

    • proposedByMemberId

      Proposal.Builder proposedByMemberId(String proposedByMemberId)

      The unique identifier of the member that created the proposal.

      Parameters:
      proposedByMemberId - The unique identifier of the member that created the proposal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proposedByMemberName

      Proposal.Builder proposedByMemberName(String proposedByMemberName)

      The name of the member that created the proposal.

      Parameters:
      proposedByMemberName - The name of the member that created the proposal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Proposal.Builder status(String status)

      The status of the proposal. Values are as follows:

      • IN_PROGRESS - The proposal is active and open for member voting.

      • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

      • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions aren't carried out.

      • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.

      • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

      Parameters:
      status - The status of the proposal. Values are as follows:

      • IN_PROGRESS - The proposal is active and open for member voting.

      • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

      • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions aren't carried out.

      • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.

      • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Proposal.Builder status(ProposalStatus status)

      The status of the proposal. Values are as follows:

      • IN_PROGRESS - The proposal is active and open for member voting.

      • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

      • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions aren't carried out.

      • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.

      • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

      Parameters:
      status - The status of the proposal. Values are as follows:

      • IN_PROGRESS - The proposal is active and open for member voting.

      • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

      • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions aren't carried out.

      • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.

      • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      Proposal.Builder creationDate(Instant creationDate)

      The date and time that the proposal was created.

      Parameters:
      creationDate - The date and time that the proposal was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expirationDate

      Proposal.Builder expirationDate(Instant expirationDate)

      The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions aren't carried out.

      Parameters:
      expirationDate - The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions aren't carried out.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • yesVoteCount

      Proposal.Builder yesVoteCount(Integer yesVoteCount)

      The current total of YES votes cast on the proposal by members.

      Parameters:
      yesVoteCount - The current total of YES votes cast on the proposal by members.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • noVoteCount

      Proposal.Builder noVoteCount(Integer noVoteCount)

      The current total of NO votes cast on the proposal by members.

      Parameters:
      noVoteCount - The current total of NO votes cast on the proposal by members.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outstandingVoteCount

      Proposal.Builder outstandingVoteCount(Integer outstandingVoteCount)

      The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.

      Parameters:
      outstandingVoteCount - The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Proposal.Builder tags(Map<String,String> tags)

      Tags assigned to the proposal. Each tag consists of a key and optional value.

      For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

      Parameters:
      tags - Tags assigned to the proposal. Each tag consists of a key and optional value.

      For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Proposal.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.