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