/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.managedblockchain.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Properties of a proposal on a Managed Blockchain network. *
** Applies only to Hyperledger Fabric. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Proposal implements Serializable, Cloneable, StructuredPojo { /** ** The unique identifier of the proposal. *
*/ private String proposalId; /** ** The unique identifier of the network for which the proposal is made. *
*/ private String networkId; /** ** The description of the proposal. *
*/ private String description; /** *
* The actions to perform on the network if the proposal is APPROVED
.
*
* The unique identifier of the member that created the proposal. *
*/ private String proposedByMemberId; /** ** The name of the member that created the proposal. *
*/ private String proposedByMemberName; /** ** 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.
*
* The date and time that the proposal was created. *
*/ private java.util.Date creationDate; /** *
* 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.
*
* The current total of YES
votes cast on the proposal by members.
*
* The current total of NO
votes cast on the proposal by members.
*
* 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.
*
* 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. *
*/ private java.util.Map* 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. *
*/ private String arn; /** ** The unique identifier of the proposal. *
* * @param proposalId * The unique identifier of the proposal. */ public void setProposalId(String proposalId) { this.proposalId = proposalId; } /** ** The unique identifier of the proposal. *
* * @return The unique identifier of the proposal. */ public String getProposalId() { return this.proposalId; } /** ** The unique identifier of the proposal. *
* * @param proposalId * The unique identifier of the proposal. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withProposalId(String proposalId) { setProposalId(proposalId); return this; } /** ** The unique identifier of the network for which the proposal is made. *
* * @param networkId * The unique identifier of the network for which the proposal is made. */ public void setNetworkId(String networkId) { this.networkId = networkId; } /** ** The unique identifier of the network for which the proposal is made. *
* * @return The unique identifier of the network for which the proposal is made. */ public String getNetworkId() { return this.networkId; } /** ** The unique identifier of the network for which the proposal is made. *
* * @param networkId * The unique identifier of the network for which the proposal is made. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withNetworkId(String networkId) { setNetworkId(networkId); return this; } /** ** The description of the proposal. *
* * @param description * The description of the proposal. */ public void setDescription(String description) { this.description = description; } /** ** The description of the proposal. *
* * @return The description of the proposal. */ public String getDescription() { return this.description; } /** ** The description of the proposal. *
* * @param description * The description of the proposal. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withDescription(String description) { setDescription(description); return this; } /** *
* The actions to perform on the network if the proposal is APPROVED
.
*
APPROVED
.
*/
public void setActions(ProposalActions actions) {
this.actions = actions;
}
/**
*
* The actions to perform on the network if the proposal is APPROVED
.
*
APPROVED
.
*/
public ProposalActions getActions() {
return this.actions;
}
/**
*
* The actions to perform on the network if the proposal is APPROVED
.
*
APPROVED
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withActions(ProposalActions actions) {
setActions(actions);
return this;
}
/**
* * The unique identifier of the member that created the proposal. *
* * @param proposedByMemberId * The unique identifier of the member that created the proposal. */ public void setProposedByMemberId(String proposedByMemberId) { this.proposedByMemberId = proposedByMemberId; } /** ** The unique identifier of the member that created the proposal. *
* * @return The unique identifier of the member that created the proposal. */ public String getProposedByMemberId() { return this.proposedByMemberId; } /** ** The unique identifier of the member that created the proposal. *
* * @param proposedByMemberId * The unique identifier of the member that created the proposal. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withProposedByMemberId(String proposedByMemberId) { setProposedByMemberId(proposedByMemberId); return this; } /** ** The name of the member that created the proposal. *
* * @param proposedByMemberName * The name of the member that created the proposal. */ public void setProposedByMemberName(String proposedByMemberName) { this.proposedByMemberName = proposedByMemberName; } /** ** The name of the member that created the proposal. *
* * @return The name of the member that created the proposal. */ public String getProposedByMemberName() { return this.proposedByMemberName; } /** ** The name of the member that created the proposal. *
* * @param proposedByMemberName * The name of the member that created the proposal. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withProposedByMemberName(String proposedByMemberName) { setProposedByMemberName(proposedByMemberName); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* The date and time that the proposal was created. *
* * @param creationDate * The date and time that the proposal was created. */ public void setCreationDate(java.util.Date creationDate) { this.creationDate = creationDate; } /** ** The date and time that the proposal was created. *
* * @return The date and time that the proposal was created. */ public java.util.Date getCreationDate() { return this.creationDate; } /** ** The date and time that the proposal was created. *
* * @param creationDate * The date and time that the proposal was created. * @return Returns a reference to this object so that method calls can be chained together. */ public Proposal withCreationDate(java.util.Date creationDate) { setCreationDate(creationDate); return this; } /** *
* 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.
*
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.
*/
public void setExpirationDate(java.util.Date expirationDate) {
this.expirationDate = 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.
*
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.
*/
public java.util.Date getExpirationDate() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withExpirationDate(java.util.Date expirationDate) {
setExpirationDate(expirationDate);
return this;
}
/**
*
* The current total of YES
votes cast on the proposal by members.
*
YES
votes cast on the proposal by members.
*/
public void setYesVoteCount(Integer yesVoteCount) {
this.yesVoteCount = yesVoteCount;
}
/**
*
* The current total of YES
votes cast on the proposal by members.
*
YES
votes cast on the proposal by members.
*/
public Integer getYesVoteCount() {
return this.yesVoteCount;
}
/**
*
* The current total of YES
votes cast on the proposal by members.
*
YES
votes cast on the proposal by members.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withYesVoteCount(Integer yesVoteCount) {
setYesVoteCount(yesVoteCount);
return this;
}
/**
*
* The current total of NO
votes cast on the proposal by members.
*
NO
votes cast on the proposal by members.
*/
public void setNoVoteCount(Integer noVoteCount) {
this.noVoteCount = noVoteCount;
}
/**
*
* The current total of NO
votes cast on the proposal by members.
*
NO
votes cast on the proposal by members.
*/
public Integer getNoVoteCount() {
return this.noVoteCount;
}
/**
*
* The current total of NO
votes cast on the proposal by members.
*
NO
votes cast on the proposal by members.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withNoVoteCount(Integer noVoteCount) {
setNoVoteCount(noVoteCount);
return this;
}
/**
*
* 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.
*
YES
votes and NO
votes.
*/
public void setOutstandingVoteCount(Integer outstandingVoteCount) {
this.outstandingVoteCount = 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.
*
YES
votes and NO
votes.
*/
public Integer getOutstandingVoteCount() {
return this.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.
*
YES
votes and NO
votes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withOutstandingVoteCount(Integer outstandingVoteCount) {
setOutstandingVoteCount(outstandingVoteCount);
return this;
}
/**
* * 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. *
* * @return 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.
*/
public java.util.Map
* 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.
*
* 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.
*/
public void setTags(java.util.Map
* 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Proposal withTags(java.util.Map
* 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.
*
* 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.
*
* 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.
*