ProposalSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.managedblockchain.model.ProposalSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProposalSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Properties of a proposal.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProposalSummary()

Constructors
Constructor and Description
`ProposalSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProposalSummary`	`clone()`
`boolean`	`equals(Object obj)`
`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`	`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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`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.
`String`	`toString()` Returns a string representation of this object.
`ProposalSummary`	`withCreationDate(Date creationDate)` The date and time that the proposal was created.
`ProposalSummary`	`withDescription(String description)` The description of the proposal.
`ProposalSummary`	`withExpirationDate(Date expirationDate)` The date and time that the proposal expires.
`ProposalSummary`	`withProposalId(String proposalId)` The unique identifier of the proposal.
`ProposalSummary`	`withProposedByMemberId(String proposedByMemberId)` The unique identifier of the member that created the proposal.
`ProposalSummary`	`withProposedByMemberName(String proposedByMemberName)` The name of the member that created the proposal.
`ProposalSummary`	`withStatus(ProposalStatus status)` The status of the proposal.
`ProposalSummary`	`withStatus(String status)` The status of the proposal.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProposalSummary
```
public ProposalSummary()
```
- Method Detail
  - setProposalId
```
public void setProposalId(String proposalId)
```
    The unique identifier of the proposal.
    
    Parameters:
    
    proposalId - The unique identifier of the proposal.
  - getProposalId
```
public String getProposalId()
```
    The unique identifier of the proposal.
    
    Returns:
    
    The unique identifier of the proposal.
  - withProposalId
```
public ProposalSummary withProposalId(String proposalId)
```
    The unique identifier of the proposal.
    
    Parameters:
    
    proposalId - The unique identifier of the proposal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the proposal.
    
    Parameters:
    
    description - The description of the proposal.
  - getDescription
```
public String getDescription()
```
    The description of the proposal.
    
    Returns:
    
    The description of the proposal.
  - withDescription
```
public ProposalSummary withDescription(String description)
```
    The description of the proposal.
    
    Parameters:
    
    description - The description of the proposal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProposedByMemberId
```
public void setProposedByMemberId(String proposedByMemberId)
```
    The unique identifier of the member that created the proposal.
    
    Parameters:
    
    proposedByMemberId - The unique identifier of the member that created the proposal.
  - getProposedByMemberId
```
public String getProposedByMemberId()
```
    The unique identifier of the member that created the proposal.
    
    Returns:
    
    The unique identifier of the member that created the proposal.
  - withProposedByMemberId
```
public ProposalSummary withProposedByMemberId(String proposedByMemberId)
```
    The unique identifier of the member that created the proposal.
    
    Parameters:
    
    proposedByMemberId - The unique identifier of the member that created the proposal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProposedByMemberName
```
public void setProposedByMemberName(String proposedByMemberName)
```
    The name of the member that created the proposal.
    
    Parameters:
    
    proposedByMemberName - The name of the member that created the proposal.
  - getProposedByMemberName
```
public String getProposedByMemberName()
```
    The name of the member that created the proposal.
    
    Returns:
    
    The name of the member that created the proposal.
  - withProposedByMemberName
```
public ProposalSummary withProposedByMemberName(String proposedByMemberName)
```
    The name of the member that created the proposal.
    
    Parameters:
    
    proposedByMemberName - The name of the member that created the proposal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
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 are not carried out.
    - EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    - ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    Parameters:
    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 are not carried out.
    
    EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    
    ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    See Also:
    
    ProposalStatus
  - getStatus
```
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 are not carried out.
    - EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    - ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    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 are not carried out.
    
    EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    
    ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    See Also:
    
    ProposalStatus
  - withStatus
```
public ProposalSummary 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 are not carried out.
    - EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    - ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    Parameters:
    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 are not carried out.
    
    EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    
    ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProposalStatus
  - withStatus
```
public ProposalSummary 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 are not carried out.
    - EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    - ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    Parameters:
    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 are not carried out.
    
    EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
    
    ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProposalStatus
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date and time that the proposal was created.
    
    Parameters:
    
    creationDate - The date and time that the proposal was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time that the proposal was created.
    
    Returns:
    
    The date and time that the proposal was created.
  - withCreationDate
```
public ProposalSummary withCreationDate(Date creationDate)
```
    The date and time that the proposal was created.
    
    Parameters:
    
    creationDate - The date and time that the proposal was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationDate
```
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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.
    
    Parameters:
    
    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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.
  - getExpirationDate
```
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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not 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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.
  - withExpirationDate
```
public ProposalSummary 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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.
    
    Parameters:
    
    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 have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProposalSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ProposalSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProposalSummary

Method Detail

setProposalId

getProposalId

withProposalId

setDescription

getDescription

withDescription

setProposedByMemberId

getProposedByMemberId

withProposedByMemberId

setProposedByMemberName

getProposedByMemberName

withProposedByMemberName

setStatus

getStatus

withStatus

withStatus

setCreationDate

getCreationDate

withCreationDate

setExpirationDate

getExpirationDate

withExpirationDate

toString

equals

hashCode

clone

marshall