blib/lib/Paws/LexRuntime/IntentSummary.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::LexRuntime::IntentSummary;
3 use Moose;
4 has CheckpointLabel => (is => 'ro', isa => 'Str', request_name => 'checkpointLabel', traits => ['NameInRequest']);
5 has ConfirmationStatus => (is => 'ro', isa => 'Str', request_name => 'confirmationStatus', traits => ['NameInRequest']);
6 has DialogActionType => (is => 'ro', isa => 'Str', request_name => 'dialogActionType', traits => ['NameInRequest'], required => 1);
7 has FulfillmentState => (is => 'ro', isa => 'Str', request_name => 'fulfillmentState', traits => ['NameInRequest']);
8 has IntentName => (is => 'ro', isa => 'Str', request_name => 'intentName', traits => ['NameInRequest']);
9 has Slots => (is => 'ro', isa => 'Paws::LexRuntime::StringMap', request_name => 'slots', traits => ['NameInRequest']);
10 has SlotToElicit => (is => 'ro', isa => 'Str', request_name => 'slotToElicit', traits => ['NameInRequest']);
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::LexRuntime::IntentSummary
19  
20 =head1 USAGE
21  
22 This class represents one of two things:
23  
24 =head3 Arguments in a call to a service
25  
26 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27 Each attribute should be used as a named argument in the calls that expect this type of object.
28  
29 As an example, if Att1 is expected to be a Paws::LexRuntime::IntentSummary object:
30  
31 $service_obj->Method(Att1 => { CheckpointLabel => $value, ..., SlotToElicit => $value });
32  
33 =head3 Results returned from an API call
34  
35 Use accessors for each attribute. If Att1 is expected to be an Paws::LexRuntime::IntentSummary object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->CheckpointLabel
39  
40 =head1 DESCRIPTION
41  
42 Provides information about the state of an intent. You can use this
43 information to get the current state of an intent so that you can
44 process the intent, or so that you can return the intent to its
45 previous state.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 CheckpointLabel => Str
51  
52 A user-defined label that identifies a particular intent. You can use
53 this label to return to a previous intent.
54  
55 Use the C<checkpointLabelFilter> parameter of the C<GetSessionRequest>
56 operation to filter the intents returned by the operation to those with
57 only the specified label.
58  
59  
60 =head2 ConfirmationStatus => Str
61  
62 The status of the intent after the user responds to the confirmation
63 prompt. If the user confirms the intent, Amazon Lex sets this field to
64 C<Confirmed>. If the user denies the intent, Amazon Lex sets this value
65 to C<Denied>. The possible values are:
66  
67 =over
68  
69 =item *
70  
71 C<Confirmed> - The user has responded "Yes" to the confirmation prompt,
72 confirming that the intent is complete and that it is ready to be
73 fulfilled.
74  
75 =item *
76  
77 C<Denied> - The user has responded "No" to the confirmation prompt.
78  
79 =item *
80  
81 C<None> - The user has never been prompted for confirmation; or, the
82 user was prompted but did not confirm or deny the prompt.
83  
84 =back
85  
86  
87  
88 =head2 B<REQUIRED> DialogActionType => Str
89  
90 The next action that the bot should take in its interaction with the
91 user. The possible values are:
92  
93 =over
94  
95 =item *
96  
97 C<ConfirmIntent> - The next action is asking the user if the intent is
98 complete and ready to be fulfilled. This is a yes/no question such as
99 "Place the order?"
100  
101 =item *
102  
103 C<Close> - Indicates that the there will not be a response from the
104 user. For example, the statement "Your order has been placed" does not
105 require a response.
106  
107 =item *
108  
109 C<ElicitIntent> - The next action is to determine the intent that the
110 user wants to fulfill.
111  
112 =item *
113  
114 C<ElicitSlot> - The next action is to elicit a slot value from the
115 user.
116  
117 =back
118  
119  
120  
121 =head2 FulfillmentState => Str
122  
123 The fulfillment state of the intent. The possible values are:
124  
125 =over
126  
127 =item *
128  
129 C<Failed> - The Lambda function associated with the intent failed to
130 fulfill the intent.
131  
132 =item *
133  
134 C<Fulfilled> - The intent has fulfilled by the Lambda function
135 associated with the intent.
136  
137 =item *
138  
139 C<ReadyForFulfillment> - All of the information necessary for the
140 intent is present and the intent ready to be fulfilled by the client
141 application.
142  
143 =back
144  
145  
146  
147 =head2 IntentName => Str
148  
149 The name of the intent.
150  
151  
152 =head2 Slots => L<Paws::LexRuntime::StringMap>
153  
154 Map of the slots that have been gathered and their values.
155  
156  
157 =head2 SlotToElicit => Str
158  
159 The next slot to elicit from the user. If there is not slot to elicit,
160 the field is blank.
161  
162  
163  
164 =head1 SEE ALSO
165  
166 This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntime>
167  
168 =head1 BUGS and CONTRIBUTIONS
169  
170 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
171  
172 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
173  
174 =cut
175