blib/lib/Paws/ManagedBlockchain/Proposal.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ManagedBlockchain::Proposal;
3 use Moose;
4 has Actions => (is => 'ro', isa => 'Paws::ManagedBlockchain::ProposalActions');
5 has Arn => (is => 'ro', isa => 'Str');
6 has CreationDate => (is => 'ro', isa => 'Str');
7 has Description => (is => 'ro', isa => 'Str');
8 has ExpirationDate => (is => 'ro', isa => 'Str');
9 has NetworkId => (is => 'ro', isa => 'Str');
10 has NoVoteCount => (is => 'ro', isa => 'Int');
11 has OutstandingVoteCount => (is => 'ro', isa => 'Int');
12 has ProposalId => (is => 'ro', isa => 'Str');
13 has ProposedByMemberId => (is => 'ro', isa => 'Str');
14 has ProposedByMemberName => (is => 'ro', isa => 'Str');
15 has Status => (is => 'ro', isa => 'Str');
16 has Tags => (is => 'ro', isa => 'Paws::ManagedBlockchain::OutputTagMap');
17 has YesVoteCount => (is => 'ro', isa => 'Int');
18  
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::ManagedBlockchain::Proposal
26  
27 =head1 USAGE
28  
29 This class represents one of two things:
30  
31 =head3 Arguments in a call to a service
32  
33 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34 Each attribute should be used as a named argument in the calls that expect this type of object.
35  
36 As an example, if Att1 is expected to be a Paws::ManagedBlockchain::Proposal object:
37  
38 $service_obj->Method(Att1 => { Actions => $value, ..., YesVoteCount => $value });
39  
40 =head3 Results returned from an API call
41  
42 Use accessors for each attribute. If Att1 is expected to be an Paws::ManagedBlockchain::Proposal object:
43  
44 $result = $service_obj->Method(...);
45 $result->Att1->Actions
46  
47 =head1 DESCRIPTION
48  
49 Properties of a proposal on a Managed Blockchain network.
50  
51 Applies only to Hyperledger Fabric.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 Actions => L<Paws::ManagedBlockchain::ProposalActions>
57  
58 The actions to perform on the network if the proposal is C<APPROVED>.
59  
60  
61 =head2 Arn => Str
62  
63 The Amazon Resource Name (ARN) of the proposal. For more information
64 about ARNs and their format, see Amazon Resource Names (ARNs)
65 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
66 in the I<AWS General Reference>.
67  
68  
69 =head2 CreationDate => Str
70  
71 The date and time that the proposal was created.
72  
73  
74 =head2 Description => Str
75  
76 The description of the proposal.
77  
78  
79 =head2 ExpirationDate => Str
80  
81 The date and time that the proposal expires. This is the
82 C<CreationDate> plus the C<ProposalDurationInHours> that is specified
83 in the C<ProposalThresholdPolicy>. After this date and time, if members
84 have not cast enough votes to determine the outcome according to the
85 voting policy, the proposal is C<EXPIRED> and C<Actions> are not
86 carried out.
87  
88  
89 =head2 NetworkId => Str
90  
91 The unique identifier of the network for which the proposal is made.
92  
93  
94 =head2 NoVoteCount => Int
95  
96 The current total of C<NO> votes cast on the proposal by members.
97  
98  
99 =head2 OutstandingVoteCount => Int
100  
101 The number of votes remaining to be cast on the proposal by members. In
102 other words, the number of members minus the sum of C<YES> votes and
103 C<NO> votes.
104  
105  
106 =head2 ProposalId => Str
107  
108 The unique identifier of the proposal.
109  
110  
111 =head2 ProposedByMemberId => Str
112  
113 The unique identifier of the member that created the proposal.
114  
115  
116 =head2 ProposedByMemberName => Str
117  
118 The name of the member that created the proposal.
119  
120  
121 =head2 Status => Str
122  
123 The status of the proposal. Values are as follows:
124  
125 =over
126  
127 =item *
128  
129 C<IN_PROGRESS> - The proposal is active and open for member voting.
130  
131 =item *
132  
133 C<APPROVED> - The proposal was approved with sufficient C<YES> votes
134 among members according to the C<VotingPolicy> specified for the
135 C<Network>. The specified proposal actions are carried out.
136  
137 =item *
138  
139 C<REJECTED> - The proposal was rejected with insufficient C<YES> votes
140 among members according to the C<VotingPolicy> specified for the
141 C<Network>. The specified C<ProposalActions> are not carried out.
142  
143 =item *
144  
145 C<EXPIRED> - Members did not cast the number of votes required to
146 determine the proposal outcome before the proposal expired. The
147 specified C<ProposalActions> are not carried out.
148  
149 =item *
150  
151 C<ACTION_FAILED> - One or more of the specified C<ProposalActions> in a
152 proposal that was approved could not be completed because of an error.
153 The C<ACTION_FAILED> status occurs even if only one ProposalAction
154 fails and other actions are successful.
155  
156 =back
157  
158  
159  
160 =head2 Tags => L<Paws::ManagedBlockchain::OutputTagMap>
161  
162 Tags assigned to the proposal. Each tag consists of a key and optional
163 value.
164  
165 For more information about tags, see Tagging Resources
166 (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html)
167 in the I<Amazon Managed Blockchain Ethereum Developer Guide>, or
168 Tagging Resources
169 (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html)
170 in the I<Amazon Managed Blockchain Hyperledger Fabric Developer Guide>.
171  
172  
173 =head2 YesVoteCount => Int
174  
175 The current total of C<YES> votes cast on the proposal by members.
176  
177  
178  
179 =head1 SEE ALSO
180  
181 This class forms part of L<Paws>, describing an object used in L<Paws::ManagedBlockchain>
182  
183 =head1 BUGS and CONTRIBUTIONS
184  
185 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
186  
187 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
188  
189 =cut
190