blib/lib/Paws/Pinpoint/Schedule.pm untested

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 11 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Pinpoint::Schedule;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str');
5 has EventFilter => (is => 'ro', isa => 'Paws::Pinpoint::CampaignEventFilter');
6 has Frequency => (is => 'ro', isa => 'Str');
7 has IsLocalTime => (is => 'ro', isa => 'Bool');
8 has QuietTime => (is => 'ro', isa => 'Paws::Pinpoint::QuietTime');
9 has StartTime => (is => 'ro', isa => 'Str', required => 1);
10 has Timezone => (is => 'ro', isa => 'Str');
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::Pinpoint::Schedule
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::Pinpoint::Schedule object:
30  
31 $service_obj->Method(Att1 => { EndTime => $value, ..., Timezone => $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::Pinpoint::Schedule object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->EndTime
39  
40 =head1 DESCRIPTION
41  
42 Specifies the schedule settings for a campaign.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 EndTime => Str
48  
49 The scheduled time, in ISO 8601 format, when the campaign ended or will
50 end.
51  
52  
53 =head2 EventFilter => L<Paws::Pinpoint::CampaignEventFilter>
54  
55 The type of event that causes the campaign to be sent, if the value of
56 the Frequency property is EVENT.
57  
58  
59 =head2 Frequency => Str
60  
61 Specifies how often the campaign is sent or whether the campaign is
62 sent in response to a specific event.
63  
64  
65 =head2 IsLocalTime => Bool
66  
67 Specifies whether the start and end times for the campaign schedule use
68 each recipient's local time. To base the schedule on each recipient's
69 local time, set this value to true.
70  
71  
72 =head2 QuietTime => L<Paws::Pinpoint::QuietTime>
73  
74 The default quiet time for the campaign. Quiet time is a specific time
75 range when a campaign doesn't send messages to endpoints, if all the
76 following conditions are met:
77  
78 =over
79  
80 =item *
81  
82 The EndpointDemographic.Timezone property of the endpoint is set to a
83 valid value.
84  
85 =item *
86  
87 The current time in the endpoint's time zone is later than or equal to
88 the time specified by the QuietTime.Start property for the campaign.
89  
90 =item *
91  
92 The current time in the endpoint's time zone is earlier than or equal
93 to the time specified by the QuietTime.End property for the campaign.
94  
95 =back
96  
97 If any of the preceding conditions isn't met, the endpoint will receive
98 messages from the campaign, even if quiet time is enabled.
99  
100  
101 =head2 B<REQUIRED> StartTime => Str
102  
103 The scheduled time when the campaign began or will begin. Valid values
104 are: IMMEDIATE, to start the campaign immediately; or, a specific time
105 in ISO 8601 format.
106  
107  
108 =head2 Timezone => Str
109  
110 The starting UTC offset for the campaign schedule, if the value of the
111 IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02,
112 UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45,
113 UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10,
114 UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05,
115 UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
116  
117  
118  
119 =head1 SEE ALSO
120  
121 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
122  
123 =head1 BUGS and CONTRIBUTIONS
124  
125 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
126  
127 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
128  
129 =cut
130