Class Proposal
- java.lang.Object
-
- software.amazon.awssdk.services.managedblockchain.model.Proposal
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Proposal.Builder,Proposal>
@Generated("software.amazon.awssdk:codegen") public final class Proposal extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Proposal.Builder,Proposal>
Properties of a proposal on a Managed Blockchain network.
Applies only to Hyperledger Fabric.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProposal.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ProposalActionsactions()The actions to perform on the network if the proposal isAPPROVED.Stringarn()The Amazon Resource Name (ARN) of the proposal.static Proposal.Builderbuilder()InstantcreationDate()The date and time that the proposal was created.Stringdescription()The description of the proposal.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpirationDate()The date and time that the proposal expires.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringnetworkId()The unique identifier of the network for which the proposal is made.IntegernoVoteCount()The current total ofNOvotes cast on the proposal by members.IntegeroutstandingVoteCount()The number of votes remaining to be cast on the proposal by members.StringproposalId()The unique identifier of the proposal.StringproposedByMemberId()The unique identifier of the member that created the proposal.StringproposedByMemberName()The name of the member that created the proposal.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Proposal.Builder>serializableBuilderClass()ProposalStatusstatus()The status of the proposal.StringstatusAsString()The status of the proposal.Map<String,String>tags()Tags assigned to the proposal.Proposal.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegeryesVoteCount()The current total ofYESvotes cast on the proposal by members.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
proposalId
public final String proposalId()
The unique identifier of the proposal.
- Returns:
- The unique identifier of the proposal.
-
networkId
public final String 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
public final String description()
The description of the proposal.
- Returns:
- The description of the proposal.
-
actions
public final ProposalActions 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
public final String proposedByMemberId()
The unique identifier of the member that created the proposal.
- Returns:
- The unique identifier of the member that created the proposal.
-
proposedByMemberName
public final String proposedByMemberName()
The name of the member that created the proposal.
- Returns:
- The name of the member that created the proposal.
-
status
public final 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 sufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specified proposal actions are carried out. -
REJECTED- The proposal was rejected with insufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specifiedProposalActionsaren't carried out. -
EXPIRED- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActionsaren't carried out. -
ACTION_FAILED- One or more of the specifiedProposalActionsin a proposal that was approved couldn't be completed because of an error. TheACTION_FAILEDstatus 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,
statuswill 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 sufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specified proposal actions are carried out. -
REJECTED- The proposal was rejected with insufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specifiedProposalActionsaren't carried out. -
EXPIRED- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActionsaren't carried out. -
ACTION_FAILED- One or more of the specifiedProposalActionsin a proposal that was approved couldn't be completed because of an error. TheACTION_FAILEDstatus occurs even if only one ProposalAction fails and other actions are successful.
-
- See Also:
ProposalStatus
-
-
statusAsString
public final String 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 sufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specified proposal actions are carried out. -
REJECTED- The proposal was rejected with insufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specifiedProposalActionsaren't carried out. -
EXPIRED- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActionsaren't carried out. -
ACTION_FAILED- One or more of the specifiedProposalActionsin a proposal that was approved couldn't be completed because of an error. TheACTION_FAILEDstatus 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,
statuswill 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 sufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specified proposal actions are carried out. -
REJECTED- The proposal was rejected with insufficientYESvotes among members according to theVotingPolicyspecified for theNetwork. The specifiedProposalActionsaren't carried out. -
EXPIRED- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specifiedProposalActionsaren't carried out. -
ACTION_FAILED- One or more of the specifiedProposalActionsin a proposal that was approved couldn't be completed because of an error. TheACTION_FAILEDstatus occurs even if only one ProposalAction fails and other actions are successful.
-
- See Also:
ProposalStatus
-
-
creationDate
public final Instant creationDate()
The date and time that the proposal was created.
- Returns:
- The date and time that the proposal was created.
-
expirationDate
public final Instant expirationDate()
The date and time that the proposal expires. This is the
CreationDateplus theProposalDurationInHoursthat 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 isEXPIREDandActionsaren't carried out.- Returns:
- The date and time that the proposal expires. This is the
CreationDateplus theProposalDurationInHoursthat 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 isEXPIREDandActionsaren't carried out.
-
yesVoteCount
public final Integer yesVoteCount()
The current total of
YESvotes cast on the proposal by members.- Returns:
- The current total of
YESvotes cast on the proposal by members.
-
noVoteCount
public final Integer noVoteCount()
The current total of
NOvotes cast on the proposal by members.- Returns:
- The current total of
NOvotes cast on the proposal by members.
-
outstandingVoteCount
public final 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
YESvotes andNOvotes.- 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
YESvotes andNOvotes.
-
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
public final 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.
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
public final 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.
- 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
public Proposal.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Proposal.Builder,Proposal>
-
builder
public static Proposal.Builder builder()
-
serializableBuilderClass
public static Class<? extends Proposal.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-