AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::ManagedBlockchain::Model::ProposalSummary Class Reference

#include <ProposalSummary.h>

Public Member Functions

 ProposalSummary ()
 
 ProposalSummary (Aws::Utils::Json::JsonView jsonValue)
 
ProposalSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetProposalId () const
 
bool ProposalIdHasBeenSet () const
 
void SetProposalId (const Aws::String &value)
 
void SetProposalId (Aws::String &&value)
 
void SetProposalId (const char *value)
 
ProposalSummaryWithProposalId (const Aws::String &value)
 
ProposalSummaryWithProposalId (Aws::String &&value)
 
ProposalSummaryWithProposalId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ProposalSummaryWithDescription (const Aws::String &value)
 
ProposalSummaryWithDescription (Aws::String &&value)
 
ProposalSummaryWithDescription (const char *value)
 
const Aws::StringGetProposedByMemberId () const
 
bool ProposedByMemberIdHasBeenSet () const
 
void SetProposedByMemberId (const Aws::String &value)
 
void SetProposedByMemberId (Aws::String &&value)
 
void SetProposedByMemberId (const char *value)
 
ProposalSummaryWithProposedByMemberId (const Aws::String &value)
 
ProposalSummaryWithProposedByMemberId (Aws::String &&value)
 
ProposalSummaryWithProposedByMemberId (const char *value)
 
const Aws::StringGetProposedByMemberName () const
 
bool ProposedByMemberNameHasBeenSet () const
 
void SetProposedByMemberName (const Aws::String &value)
 
void SetProposedByMemberName (Aws::String &&value)
 
void SetProposedByMemberName (const char *value)
 
ProposalSummaryWithProposedByMemberName (const Aws::String &value)
 
ProposalSummaryWithProposedByMemberName (Aws::String &&value)
 
ProposalSummaryWithProposedByMemberName (const char *value)
 
const ProposalStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ProposalStatus &value)
 
void SetStatus (ProposalStatus &&value)
 
ProposalSummaryWithStatus (const ProposalStatus &value)
 
ProposalSummaryWithStatus (ProposalStatus &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
ProposalSummaryWithCreationDate (const Aws::Utils::DateTime &value)
 
ProposalSummaryWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetExpirationDate () const
 
bool ExpirationDateHasBeenSet () const
 
void SetExpirationDate (const Aws::Utils::DateTime &value)
 
void SetExpirationDate (Aws::Utils::DateTime &&value)
 
ProposalSummaryWithExpirationDate (const Aws::Utils::DateTime &value)
 
ProposalSummaryWithExpirationDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
ProposalSummaryWithArn (const Aws::String &value)
 
ProposalSummaryWithArn (Aws::String &&value)
 
ProposalSummaryWithArn (const char *value)
 

Detailed Description

Properties of a proposal.

Applies only to Hyperledger Fabric.

See Also:

AWS API Reference

Definition at line 34 of file ProposalSummary.h.

Constructor & Destructor Documentation

◆ ProposalSummary() [1/2]

Aws::ManagedBlockchain::Model::ProposalSummary::ProposalSummary ( )

◆ ProposalSummary() [2/2]

Aws::ManagedBlockchain::Model::ProposalSummary::ProposalSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 428 of file ProposalSummary.h.

◆ CreationDateHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::CreationDateHasBeenSet ( ) const
inline

The date and time that the proposal was created.

Definition at line 330 of file ProposalSummary.h.

◆ DescriptionHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::DescriptionHasBeenSet ( ) const
inline

The description of the proposal.

Definition at line 92 of file ProposalSummary.h.

◆ ExpirationDateHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::ExpirationDateHasBeenSet ( ) const
inline

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.

Definition at line 371 of file ProposalSummary.h.

◆ GetArn()

const Aws::String& Aws::ManagedBlockchain::Model::ProposalSummary::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 420 of file ProposalSummary.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::ManagedBlockchain::Model::ProposalSummary::GetCreationDate ( ) const
inline

The date and time that the proposal was created.

Definition at line 325 of file ProposalSummary.h.

◆ GetDescription()

const Aws::String& Aws::ManagedBlockchain::Model::ProposalSummary::GetDescription ( ) const
inline

The description of the proposal.

Definition at line 87 of file ProposalSummary.h.

◆ GetExpirationDate()

const Aws::Utils::DateTime& Aws::ManagedBlockchain::Model::ProposalSummary::GetExpirationDate ( ) const
inline

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.

Definition at line 361 of file ProposalSummary.h.

◆ GetProposalId()

const Aws::String& Aws::ManagedBlockchain::Model::ProposalSummary::GetProposalId ( ) const
inline

The unique identifier of the proposal.

Definition at line 46 of file ProposalSummary.h.

◆ GetProposedByMemberId()

const Aws::String& Aws::ManagedBlockchain::Model::ProposalSummary::GetProposedByMemberId ( ) const
inline

The unique identifier of the member that created the proposal.

Definition at line 128 of file ProposalSummary.h.

◆ GetProposedByMemberName()

const Aws::String& Aws::ManagedBlockchain::Model::ProposalSummary::GetProposedByMemberName ( ) const
inline

The name of the member that created the proposal.

Definition at line 169 of file ProposalSummary.h.

◆ GetStatus()

const ProposalStatus& Aws::ManagedBlockchain::Model::ProposalSummary::GetStatus ( ) const
inline

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.

Definition at line 224 of file ProposalSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ManagedBlockchain::Model::ProposalSummary::Jsonize ( ) const

◆ operator=()

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProposalIdHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::ProposalIdHasBeenSet ( ) const
inline

The unique identifier of the proposal.

Definition at line 51 of file ProposalSummary.h.

◆ ProposedByMemberIdHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::ProposedByMemberIdHasBeenSet ( ) const
inline

The unique identifier of the member that created the proposal.

Definition at line 133 of file ProposalSummary.h.

◆ ProposedByMemberNameHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::ProposedByMemberNameHasBeenSet ( ) const
inline

The name of the member that created the proposal.

Definition at line 174 of file ProposalSummary.h.

◆ SetArn() [1/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 444 of file ProposalSummary.h.

◆ SetArn() [2/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 436 of file ProposalSummary.h.

◆ SetArn() [3/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 452 of file ProposalSummary.h.

◆ SetCreationDate() [1/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time that the proposal was created.

Definition at line 340 of file ProposalSummary.h.

◆ SetCreationDate() [2/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time that the proposal was created.

Definition at line 335 of file ProposalSummary.h.

◆ SetDescription() [1/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetDescription ( Aws::String &&  value)
inline

The description of the proposal.

Definition at line 102 of file ProposalSummary.h.

◆ SetDescription() [2/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetDescription ( const Aws::String value)
inline

The description of the proposal.

Definition at line 97 of file ProposalSummary.h.

◆ SetDescription() [3/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetDescription ( const char *  value)
inline

The description of the proposal.

Definition at line 107 of file ProposalSummary.h.

◆ SetExpirationDate() [1/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetExpirationDate ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 391 of file ProposalSummary.h.

◆ SetExpirationDate() [2/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetExpirationDate ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 381 of file ProposalSummary.h.

◆ SetProposalId() [1/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposalId ( Aws::String &&  value)
inline

The unique identifier of the proposal.

Definition at line 61 of file ProposalSummary.h.

◆ SetProposalId() [2/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposalId ( const Aws::String value)
inline

The unique identifier of the proposal.

Definition at line 56 of file ProposalSummary.h.

◆ SetProposalId() [3/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposalId ( const char *  value)
inline

The unique identifier of the proposal.

Definition at line 66 of file ProposalSummary.h.

◆ SetProposedByMemberId() [1/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberId ( Aws::String &&  value)
inline

The unique identifier of the member that created the proposal.

Definition at line 143 of file ProposalSummary.h.

◆ SetProposedByMemberId() [2/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberId ( const Aws::String value)
inline

The unique identifier of the member that created the proposal.

Definition at line 138 of file ProposalSummary.h.

◆ SetProposedByMemberId() [3/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberId ( const char *  value)
inline

The unique identifier of the member that created the proposal.

Definition at line 148 of file ProposalSummary.h.

◆ SetProposedByMemberName() [1/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberName ( Aws::String &&  value)
inline

The name of the member that created the proposal.

Definition at line 184 of file ProposalSummary.h.

◆ SetProposedByMemberName() [2/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberName ( const Aws::String value)
inline

The name of the member that created the proposal.

Definition at line 179 of file ProposalSummary.h.

◆ SetProposedByMemberName() [3/3]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetProposedByMemberName ( const char *  value)
inline

The name of the member that created the proposal.

Definition at line 189 of file ProposalSummary.h.

◆ SetStatus() [1/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetStatus ( const ProposalStatus value)
inline

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.

Definition at line 262 of file ProposalSummary.h.

◆ SetStatus() [2/2]

void Aws::ManagedBlockchain::Model::ProposalSummary::SetStatus ( ProposalStatus &&  value)
inline

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.

Definition at line 281 of file ProposalSummary.h.

◆ StatusHasBeenSet()

bool Aws::ManagedBlockchain::Model::ProposalSummary::StatusHasBeenSet ( ) const
inline

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.

Definition at line 243 of file ProposalSummary.h.

◆ WithArn() [1/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 468 of file ProposalSummary.h.

◆ WithArn() [2/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 460 of file ProposalSummary.h.

◆ WithArn() [3/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.

Definition at line 476 of file ProposalSummary.h.

◆ WithCreationDate() [1/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time that the proposal was created.

Definition at line 350 of file ProposalSummary.h.

◆ WithCreationDate() [2/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time that the proposal was created.

Definition at line 345 of file ProposalSummary.h.

◆ WithDescription() [1/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithDescription ( Aws::String &&  value)
inline

The description of the proposal.

Definition at line 117 of file ProposalSummary.h.

◆ WithDescription() [2/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithDescription ( const Aws::String value)
inline

The description of the proposal.

Definition at line 112 of file ProposalSummary.h.

◆ WithDescription() [3/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithDescription ( const char *  value)
inline

The description of the proposal.

Definition at line 122 of file ProposalSummary.h.

◆ WithExpirationDate() [1/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithExpirationDate ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 411 of file ProposalSummary.h.

◆ WithExpirationDate() [2/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithExpirationDate ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 401 of file ProposalSummary.h.

◆ WithProposalId() [1/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposalId ( Aws::String &&  value)
inline

The unique identifier of the proposal.

Definition at line 76 of file ProposalSummary.h.

◆ WithProposalId() [2/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposalId ( const Aws::String value)
inline

The unique identifier of the proposal.

Definition at line 71 of file ProposalSummary.h.

◆ WithProposalId() [3/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposalId ( const char *  value)
inline

The unique identifier of the proposal.

Definition at line 81 of file ProposalSummary.h.

◆ WithProposedByMemberId() [1/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberId ( Aws::String &&  value)
inline

The unique identifier of the member that created the proposal.

Definition at line 158 of file ProposalSummary.h.

◆ WithProposedByMemberId() [2/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberId ( const Aws::String value)
inline

The unique identifier of the member that created the proposal.

Definition at line 153 of file ProposalSummary.h.

◆ WithProposedByMemberId() [3/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberId ( const char *  value)
inline

The unique identifier of the member that created the proposal.

Definition at line 163 of file ProposalSummary.h.

◆ WithProposedByMemberName() [1/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberName ( Aws::String &&  value)
inline

The name of the member that created the proposal.

Definition at line 199 of file ProposalSummary.h.

◆ WithProposedByMemberName() [2/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberName ( const Aws::String value)
inline

The name of the member that created the proposal.

Definition at line 194 of file ProposalSummary.h.

◆ WithProposedByMemberName() [3/3]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithProposedByMemberName ( const char *  value)
inline

The name of the member that created the proposal.

Definition at line 204 of file ProposalSummary.h.

◆ WithStatus() [1/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithStatus ( const ProposalStatus value)
inline

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.

Definition at line 300 of file ProposalSummary.h.

◆ WithStatus() [2/2]

ProposalSummary& Aws::ManagedBlockchain::Model::ProposalSummary::WithStatus ( ProposalStatus &&  value)
inline

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.

Definition at line 319 of file ProposalSummary.h.


The documentation for this class was generated from the following file: