File Coverage

blib/lib/Paws/Pinpoint/WriteCampaignRequest.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Pinpoint::WriteCampaignRequest;
2 1     1   589 use Moose;
  1         5  
  1         9  
3             has AdditionalTreatments => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::WriteTreatmentResource]');
4             has Description => (is => 'ro', isa => 'Str');
5             has HoldoutPercent => (is => 'ro', isa => 'Int');
6             has IsPaused => (is => 'ro', isa => 'Bool');
7             has Limits => (is => 'ro', isa => 'Paws::Pinpoint::CampaignLimits');
8             has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::MessageConfiguration');
9             has Name => (is => 'ro', isa => 'Str');
10             has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::Schedule');
11             has SegmentId => (is => 'ro', isa => 'Str');
12             has SegmentVersion => (is => 'ro', isa => 'Int');
13             has TreatmentDescription => (is => 'ro', isa => 'Str');
14             has TreatmentName => (is => 'ro', isa => 'Str');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::Pinpoint::WriteCampaignRequest
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::Pinpoint::WriteCampaignRequest object:
33              
34             $service_obj->Method(Att1 => { AdditionalTreatments => $value, ..., TreatmentName => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteCampaignRequest object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->AdditionalTreatments
42              
43             =head1 DESCRIPTION
44              
45             Used to create a campaign.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 AdditionalTreatments => ArrayRef[L<Paws::Pinpoint::WriteTreatmentResource>]
51              
52             Treatments that are defined in addition to the default treatment.
53              
54              
55             =head2 Description => Str
56              
57             A description of the campaign.
58              
59              
60             =head2 HoldoutPercent => Int
61              
62             The allocated percentage of end users who will not receive messages
63             from this campaign.
64              
65              
66             =head2 IsPaused => Bool
67              
68             Indicates whether the campaign is paused. A paused campaign does not
69             send messages unless you resume it by setting IsPaused to false.
70              
71              
72             =head2 Limits => L<Paws::Pinpoint::CampaignLimits>
73              
74             The campaign limits settings.
75              
76              
77             =head2 MessageConfiguration => L<Paws::Pinpoint::MessageConfiguration>
78              
79             The message configuration settings.
80              
81              
82             =head2 Name => Str
83              
84             The custom name of the campaign.
85              
86              
87             =head2 Schedule => L<Paws::Pinpoint::Schedule>
88              
89             The campaign schedule.
90              
91              
92             =head2 SegmentId => Str
93              
94             The ID of the segment to which the campaign sends messages.
95              
96              
97             =head2 SegmentVersion => Int
98              
99             The version of the segment to which the campaign sends messages.
100              
101              
102             =head2 TreatmentDescription => Str
103              
104             A custom description for the treatment.
105              
106              
107             =head2 TreatmentName => Str
108              
109             The custom name of a variation of the campaign used for A/B testing.
110              
111              
112              
113             =head1 SEE ALSO
114              
115             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
116              
117             =head1 BUGS and CONTRIBUTIONS
118              
119             The source code is located here: https://github.com/pplu/aws-sdk-perl
120              
121             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
122              
123             =cut
124