@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Proposal extends Object implements Serializable, Cloneable, StructuredPojo
Properties of a proposal on a Managed Blockchain network.
Applies only to Hyperledger Fabric.
Constructor and Description |
---|
Proposal() |
Modifier and Type | Method and Description |
---|---|
Proposal |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
Proposal |
clearTagsEntries()
Removes all the entries added into Tags.
|
Proposal |
clone() |
boolean |
equals(Object obj) |
ProposalActions |
getActions()
The actions to perform on the network if the proposal is
APPROVED . |
String |
getArn()
The Amazon Resource Name (ARN) of the proposal.
|
Date |
getCreationDate()
The date and time that the proposal was created.
|
String |
getDescription()
The description of the proposal.
|
Date |
getExpirationDate()
The date and time that the proposal expires.
|
String |
getNetworkId()
The unique identifier of the network for which the proposal is made.
|
Integer |
getNoVoteCount()
The current total of
NO votes cast on the proposal by members. |
Integer |
getOutstandingVoteCount()
The number of votes remaining to be cast on the proposal by members.
|
String |
getProposalId()
The unique identifier of the proposal.
|
String |
getProposedByMemberId()
The unique identifier of the member that created the proposal.
|
String |
getProposedByMemberName()
The name of the member that created the proposal.
|
String |
getStatus()
The status of the proposal.
|
Map<String,String> |
getTags()
Tags assigned to the proposal.
|
Integer |
getYesVoteCount()
The current total of
YES votes cast on the proposal by members. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setActions(ProposalActions actions)
The actions to perform on the network if the proposal is
APPROVED . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the proposal.
|
void |
setCreationDate(Date creationDate)
The date and time that the proposal was created.
|
void |
setDescription(String description)
The description of the proposal.
|
void |
setExpirationDate(Date expirationDate)
The date and time that the proposal expires.
|
void |
setNetworkId(String networkId)
The unique identifier of the network for which the proposal is made.
|
void |
setNoVoteCount(Integer noVoteCount)
The current total of
NO votes cast on the proposal by members. |
void |
setOutstandingVoteCount(Integer outstandingVoteCount)
The number of votes remaining to be cast on the proposal by members.
|
void |
setProposalId(String proposalId)
The unique identifier of the proposal.
|
void |
setProposedByMemberId(String proposedByMemberId)
The unique identifier of the member that created the proposal.
|
void |
setProposedByMemberName(String proposedByMemberName)
The name of the member that created the proposal.
|
void |
setStatus(String status)
The status of the proposal.
|
void |
setTags(Map<String,String> tags)
Tags assigned to the proposal.
|
void |
setYesVoteCount(Integer yesVoteCount)
The current total of
YES votes cast on the proposal by members. |
String |
toString()
Returns a string representation of this object.
|
Proposal |
withActions(ProposalActions actions)
The actions to perform on the network if the proposal is
APPROVED . |
Proposal |
withArn(String arn)
The Amazon Resource Name (ARN) of the proposal.
|
Proposal |
withCreationDate(Date creationDate)
The date and time that the proposal was created.
|
Proposal |
withDescription(String description)
The description of the proposal.
|
Proposal |
withExpirationDate(Date expirationDate)
The date and time that the proposal expires.
|
Proposal |
withNetworkId(String networkId)
The unique identifier of the network for which the proposal is made.
|
Proposal |
withNoVoteCount(Integer noVoteCount)
The current total of
NO votes cast on the proposal by members. |
Proposal |
withOutstandingVoteCount(Integer outstandingVoteCount)
The number of votes remaining to be cast on the proposal by members.
|
Proposal |
withProposalId(String proposalId)
The unique identifier of the proposal.
|
Proposal |
withProposedByMemberId(String proposedByMemberId)
The unique identifier of the member that created the proposal.
|
Proposal |
withProposedByMemberName(String proposedByMemberName)
The name of the member that created the proposal.
|
Proposal |
withStatus(ProposalStatus status)
The status of the proposal.
|
Proposal |
withStatus(String status)
The status of the proposal.
|
Proposal |
withTags(Map<String,String> tags)
Tags assigned to the proposal.
|
Proposal |
withYesVoteCount(Integer yesVoteCount)
The current total of
YES votes cast on the proposal by members. |
public void setProposalId(String proposalId)
The unique identifier of the proposal.
proposalId
- The unique identifier of the proposal.public String getProposalId()
The unique identifier of the proposal.
public Proposal withProposalId(String proposalId)
The unique identifier of the proposal.
proposalId
- The unique identifier of the proposal.public void setNetworkId(String networkId)
The unique identifier of the network for which the proposal is made.
networkId
- The unique identifier of the network for which the proposal is made.public String getNetworkId()
The unique identifier of the network for which the proposal is made.
public Proposal withNetworkId(String networkId)
The unique identifier of the network for which the proposal is made.
networkId
- The unique identifier of the network for which the proposal is made.public void setDescription(String description)
The description of the proposal.
description
- The description of the proposal.public String getDescription()
The description of the proposal.
public Proposal withDescription(String description)
The description of the proposal.
description
- The description of the proposal.public void setActions(ProposalActions actions)
The actions to perform on the network if the proposal is APPROVED
.
actions
- The actions to perform on the network if the proposal is APPROVED
.public ProposalActions getActions()
The actions to perform on the network if the proposal is APPROVED
.
APPROVED
.public Proposal withActions(ProposalActions actions)
The actions to perform on the network if the proposal is APPROVED
.
actions
- The actions to perform on the network if the proposal is APPROVED
.public void setProposedByMemberId(String proposedByMemberId)
The unique identifier of the member that created the proposal.
proposedByMemberId
- The unique identifier of the member that created the proposal.public String getProposedByMemberId()
The unique identifier of the member that created the proposal.
public Proposal withProposedByMemberId(String proposedByMemberId)
The unique identifier of the member that created the proposal.
proposedByMemberId
- The unique identifier of the member that created the proposal.public void setProposedByMemberName(String proposedByMemberName)
The name of the member that created the proposal.
proposedByMemberName
- The name of the member that created the proposal.public String getProposedByMemberName()
The name of the member that created the proposal.
public Proposal withProposedByMemberName(String proposedByMemberName)
The name of the member that created the proposal.
proposedByMemberName
- The name of the member that created the proposal.public void setStatus(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.
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.
ProposalStatus
public String getStatus()
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.
ProposalStatus
public Proposal withStatus(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.
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.
ProposalStatus
public Proposal withStatus(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.
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.
ProposalStatus
public void setCreationDate(Date creationDate)
The date and time that the proposal was created.
creationDate
- The date and time that the proposal was created.public Date getCreationDate()
The date and time that the proposal was created.
public Proposal withCreationDate(Date creationDate)
The date and time that the proposal was created.
creationDate
- The date and time that the proposal was created.public void setExpirationDate(Date 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.
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.public Date getExpirationDate()
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 Proposal withExpirationDate(Date 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.
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.public void setYesVoteCount(Integer yesVoteCount)
The current total of YES
votes cast on the proposal by members.
yesVoteCount
- The current total of YES
votes cast on the proposal by members.public Integer getYesVoteCount()
The current total of YES
votes cast on the proposal by members.
YES
votes cast on the proposal by members.public Proposal withYesVoteCount(Integer yesVoteCount)
The current total of YES
votes cast on the proposal by members.
yesVoteCount
- The current total of YES
votes cast on the proposal by members.public void setNoVoteCount(Integer noVoteCount)
The current total of NO
votes cast on the proposal by members.
noVoteCount
- The current total of NO
votes cast on the proposal by members.public Integer getNoVoteCount()
The current total of NO
votes cast on the proposal by members.
NO
votes cast on the proposal by members.public Proposal withNoVoteCount(Integer noVoteCount)
The current total of NO
votes cast on the proposal by members.
noVoteCount
- The current total of NO
votes cast on the proposal by members.public void setOutstandingVoteCount(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.
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.public Integer getOutstandingVoteCount()
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 Proposal withOutstandingVoteCount(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.
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.public Map<String,String> getTags()
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(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.
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.
public Proposal withTags(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.
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.
public Proposal clearTagsEntries()
public void setArn(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.
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.public String getArn()
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.
public Proposal withArn(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.
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.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.