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:

  • Method Details

    • 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 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.

      If the service returns an enum value that is not available in the current SDK version, status will return ProposalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 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.

      See Also:

    • 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 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.

      If the service returns an enum value that is not available in the current SDK version, status will return ProposalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 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.

      See Also:

    • 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 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.

      Returns:
      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.

    • 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()
      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 interface ToCopyableBuilder<ProposalSummary.Builder,ProposalSummary>
      Returns:
      a builder for type T

    • builder

      public static ProposalSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProposalSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.