Class ProposalSummary
- java.lang.Object
-
- software.amazon.awssdk.services.managedblockchain.model.ProposalSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ProposalSummary.Builder,ProposalSummary>
@Generated("software.amazon.awssdk:codegen") public final class ProposalSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProposalSummary.Builder,ProposalSummary>
Properties of a proposal.
Applies only to Hyperledger Fabric.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProposalSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the proposal.static ProposalSummary.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()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 ProposalSummary.Builder>serializableBuilderClass()ProposalStatusstatus()The status of the proposal.StringstatusAsString()The status of the proposal.ProposalSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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.
-
description
public final String description()
The description of the proposal.
- Returns:
- The description of the proposal.
-
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.
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.
-
- 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.
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.
-
- 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.
-
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 ProposalSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ProposalSummary.Builder,ProposalSummary>
-
builder
public static ProposalSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProposalSummary.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
-
-