blib/lib/Paws/LexRuntime/DialogAction.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::DialogAction;
3 use Moose;
4 has FulfillmentState => (is => 'ro', isa => 'Str', request_name => 'fulfillmentState', traits => ['NameInRequest']);
5 has IntentName => (is => 'ro', isa => 'Str', request_name => 'intentName', traits => ['NameInRequest']);
6 has Message => (is => 'ro', isa => 'Str', request_name => 'message', traits => ['NameInRequest']);
7 has MessageFormat => (is => 'ro', isa => 'Str', request_name => 'messageFormat', traits => ['NameInRequest']);
8 has Slots => (is => 'ro', isa => 'Paws::LexRuntime::StringMap', request_name => 'slots', traits => ['NameInRequest']);
9 has SlotToElicit => (is => 'ro', isa => 'Str', request_name => 'slotToElicit', traits => ['NameInRequest']);
10 has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1);
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::LexRuntime::DialogAction
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::DialogAction object:
30  
31 $service_obj->Method(Att1 => { FulfillmentState => $value, ..., Type => $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::DialogAction object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->FulfillmentState
39  
40 =head1 DESCRIPTION
41  
42 Describes the next action that the bot should take in its interaction
43 with the user and provides information about the context in which the
44 action takes place. Use the C<DialogAction> data type to set the
45 interaction to a specific state, or to return the interaction to a
46 previous state.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 FulfillmentState => Str
52  
53 The fulfillment state of the intent. The possible values are:
54  
55 =over
56  
57 =item *
58  
59 C<Failed> - The Lambda function associated with the intent failed to
60 fulfill the intent.
61  
62 =item *
63  
64 C<Fulfilled> - The intent has fulfilled by the Lambda function
65 associated with the intent.
66  
67 =item *
68  
69 C<ReadyForFulfillment> - All of the information necessary for the
70 intent is present and the intent ready to be fulfilled by the client
71 application.
72  
73 =back
74  
75  
76  
77 =head2 IntentName => Str
78  
79 The name of the intent.
80  
81  
82 =head2 Message => Str
83  
84 The message that should be shown to the user. If you don't specify a
85 message, Amazon Lex will use the message configured for the intent.
86  
87  
88 =head2 MessageFormat => Str
89  
90 =over
91  
92 =item *
93  
94 C<PlainText> - The message contains plain UTF-8 text.
95  
96 =item *
97  
98 C<CustomPayload> - The message is a custom format for the client.
99  
100 =item *
101  
102 C<SSML> - The message contains text formatted for voice output.
103  
104 =item *
105  
106 C<Composite> - The message contains an escaped JSON object containing
107 one or more messages. For more information, see Message Groups
108 (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html).
109  
110 =back
111  
112  
113  
114 =head2 Slots => L<Paws::LexRuntime::StringMap>
115  
116 Map of the slots that have been gathered and their values.
117  
118  
119 =head2 SlotToElicit => Str
120  
121 The name of the slot that should be elicited from the user.
122  
123  
124 =head2 B<REQUIRED> Type => Str
125  
126 The next action that the bot should take in its interaction with the
127 user. The possible values are:
128  
129 =over
130  
131 =item *
132  
133 C<ConfirmIntent> - The next action is asking the user if the intent is
134 complete and ready to be fulfilled. This is a yes/no question such as
135 "Place the order?"
136  
137 =item *
138  
139 C<Close> - Indicates that the there will not be a response from the
140 user. For example, the statement "Your order has been placed" does not
141 require a response.
142  
143 =item *
144  
145 C<Delegate> - The next action is determined by Amazon Lex.
146  
147 =item *
148  
149 C<ElicitIntent> - The next action is to determine the intent that the
150 user wants to fulfill.
151  
152 =item *
153  
154 C<ElicitSlot> - The next action is to elicit a slot value from the
155 user.
156  
157 =back
158  
159  
160  
161  
162 =head1 SEE ALSO
163  
164 This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntime>
165  
166 =head1 BUGS and CONTRIBUTIONS
167  
168 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
169  
170 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
171  
172 =cut
173