Class Proposal
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Proposal.Builder,
Proposal>
Properties of a proposal on a Managed Blockchain network.
Applies only to Hyperledger Fabric.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ProposalActions
actions()
The actions to perform on the network if the proposal isAPPROVED
.final String
arn()
The Amazon Resource Name (ARN) of the proposal.static Proposal.Builder
builder()
final Instant
The date and time that the proposal was created.final String
The description of the proposal.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The date and time that the proposal expires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The unique identifier of the network for which the proposal is made.final Integer
The current total ofNO
votes cast on the proposal by members.final Integer
The number of votes remaining to be cast on the proposal by members.final String
The unique identifier of the proposal.final String
The unique identifier of the member that created the proposal.final String
The name of the member that created the proposal.static Class
<? extends Proposal.Builder> final ProposalStatus
status()
The status of the proposal.final String
The status of the proposal.tags()
Tags assigned to the proposal.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The current total ofYES
votes cast on the proposal by members.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
proposalId
The unique identifier of the proposal.
- Returns:
- The unique identifier of the proposal.
-
networkId
The unique identifier of the network for which the proposal is made.
- Returns:
- The unique identifier of the network for which the proposal is made.
-
description
The description of the proposal.
- Returns:
- The description of the proposal.
-
actions
The actions to perform on the network if the proposal is
APPROVED
.- Returns:
- The actions to perform on the network if the proposal is
APPROVED
.
-
proposedByMemberId
The unique identifier of the member that created the proposal.
- Returns:
- The unique identifier of the member that created the proposal.
-
proposedByMemberName
The name of the member that created the proposal.
- Returns:
- The name of the member that created the proposal.
-
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 sufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specified proposal actions are carried out. -
REJECTED
- The proposal was rejected with insufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specifiedProposalActions
aren't carried out. -
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActions
aren't carried out. -
ACTION_FAILED
- One or more of the specifiedProposalActions
in a proposal that was approved couldn't be completed because of an error. TheACTION_FAILED
status occurs even if only one ProposalAction fails and other actions are successful.
If the service returns an enum value that is not available in the current SDK version,
status
will returnProposalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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 sufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specified proposal actions are carried out. -
REJECTED
- The proposal was rejected with insufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specifiedProposalActions
aren't carried out. -
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActions
aren't carried out. -
ACTION_FAILED
- One or more of the specifiedProposalActions
in a proposal that was approved couldn't be completed because of an error. TheACTION_FAILED
status occurs even if only one ProposalAction fails and other actions are successful.
-
- See Also:
-
-
statusAsString
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 sufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specified proposal actions are carried out. -
REJECTED
- The proposal was rejected with insufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specifiedProposalActions
aren't carried out. -
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActions
aren't carried out. -
ACTION_FAILED
- One or more of the specifiedProposalActions
in a proposal that was approved couldn't be completed because of an error. TheACTION_FAILED
status occurs even if only one ProposalAction fails and other actions are successful.
If the service returns an enum value that is not available in the current SDK version,
status
will returnProposalStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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 sufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specified proposal actions are carried out. -
REJECTED
- The proposal was rejected with insufficientYES
votes among members according to theVotingPolicy
specified for theNetwork
. The specifiedProposalActions
aren't carried out. -
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActions
aren't carried out. -
ACTION_FAILED
- One or more of the specifiedProposalActions
in a proposal that was approved couldn't be completed because of an error. TheACTION_FAILED
status occurs even if only one ProposalAction fails and other actions are successful.
-
- See Also:
-
-
creationDate
The date and time that the proposal was created.
- Returns:
- The date and time that the proposal was created.
-
expirationDate
The date and time that the proposal expires. This is the
CreationDate
plus theProposalDurationInHours
that is specified in theProposalThresholdPolicy
. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal isEXPIRED
andActions
aren't carried out.- Returns:
- The date and time that the proposal expires. This is the
CreationDate
plus theProposalDurationInHours
that is specified in theProposalThresholdPolicy
. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal isEXPIRED
andActions
aren't carried out.
-
yesVoteCount
The current total of
YES
votes cast on the proposal by members.- Returns:
- The current total of
YES
votes cast on the proposal by members.
-
noVoteCount
The current total of
NO
votes cast on the proposal by members.- Returns:
- The current total of
NO
votes cast on the proposal by members.
-
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 andNO
votes.- Returns:
- 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 andNO
votes.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasTags()
method.- Returns:
- 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.
-
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:
- 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.
-
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 interfaceToCopyableBuilder<Proposal.Builder,
Proposal> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-