File Coverage

blib/lib/Paws/Pinpoint/CampaignResponse.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	sub	time	code
1				package Paws::Pinpoint::CampaignResponse;
2	1	1	315	use Moose;
	1		3
	1		7
3				has AdditionalTreatments => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::TreatmentResource]');
4				has ApplicationId => (is => 'ro', isa => 'Str');
5				has CreationDate => (is => 'ro', isa => 'Str');
6				has DefaultState => (is => 'ro', isa => 'Paws::Pinpoint::CampaignState');
7				has Description => (is => 'ro', isa => 'Str');
8				has HoldoutPercent => (is => 'ro', isa => 'Int');
9				has Id => (is => 'ro', isa => 'Str');
10				has IsPaused => (is => 'ro', isa => 'Bool');
11				has LastModifiedDate => (is => 'ro', isa => 'Str');
12				has Limits => (is => 'ro', isa => 'Paws::Pinpoint::CampaignLimits');
13				has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::MessageConfiguration');
14				has Name => (is => 'ro', isa => 'Str');
15				has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::Schedule');
16				has SegmentId => (is => 'ro', isa => 'Str');
17				has SegmentVersion => (is => 'ro', isa => 'Int');
18				has State => (is => 'ro', isa => 'Paws::Pinpoint::CampaignState');
19				has TreatmentDescription => (is => 'ro', isa => 'Str');
20				has TreatmentName => (is => 'ro', isa => 'Str');
21				has Version => (is => 'ro', isa => 'Int');
22				1;
23
24				### main pod documentation begin ###
25
26				=head1 NAME
27
28				Paws::Pinpoint::CampaignResponse
29
30				=head1 USAGE
31
32				This class represents one of two things:
33
34				=head3 Arguments in a call to a service
35
36				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
37				Each attribute should be used as a named argument in the calls that expect this type of object.
38
39				As an example, if Att1 is expected to be a Paws::Pinpoint::CampaignResponse object:
40
41				$service_obj->Method(Att1 => { AdditionalTreatments => $value, ..., Version => $value });
42
43				=head3 Results returned from an API call
44
45				Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::CampaignResponse object:
46
47				$result = $service_obj->Method(...);
48				$result->Att1->AdditionalTreatments
49
50				=head1 DESCRIPTION
51
52				Campaign definition
53
54				=head1 ATTRIBUTES
55
56
57				=head2 AdditionalTreatments => ArrayRef[L<Paws::Pinpoint::TreatmentResource>]
58
59				Treatments that are defined in addition to the default treatment.
60
61
62				=head2 ApplicationId => Str
63
64				The ID of the application to which the campaign applies.
65
66
67				=head2 CreationDate => Str
68
69				The date the campaign was created in ISO 8601 format.
70
71
72				=head2 DefaultState => L<Paws::Pinpoint::CampaignState>
73
74				The status of the campaign's default treatment. Only present for A/B
75				test campaigns.
76
77
78				=head2 Description => Str
79
80				A description of the campaign.
81
82
83				=head2 HoldoutPercent => Int
84
85				The allocated percentage of end users who will not receive messages
86				from this campaign.
87
88
89				=head2 Id => Str
90
91				The unique campaign ID.
92
93
94				=head2 IsPaused => Bool
95
96				Indicates whether the campaign is paused. A paused campaign does not
97				send messages unless you resume it by setting IsPaused to false.
98
99
100				=head2 LastModifiedDate => Str
101
102				The date the campaign was last updated in ISO 8601 format.
103
104
105				=head2 Limits => L<Paws::Pinpoint::CampaignLimits>
106
107				The campaign limits settings.
108
109
110				=head2 MessageConfiguration => L<Paws::Pinpoint::MessageConfiguration>
111
112				The message configuration settings.
113
114
115				=head2 Name => Str
116
117				The custom name of the campaign.
118
119
120				=head2 Schedule => L<Paws::Pinpoint::Schedule>
121
122				The campaign schedule.
123
124
125				=head2 SegmentId => Str
126
127				The ID of the segment to which the campaign sends messages.
128
129
130				=head2 SegmentVersion => Int
131
132				The version of the segment to which the campaign sends messages.
133
134
135				=head2 State => L<Paws::Pinpoint::CampaignState>
136
137				The campaign status. An A/B test campaign will have a status of
138				COMPLETED only when all treatments have a status of COMPLETED.
139
140
141				=head2 TreatmentDescription => Str
142
143				A custom description for the treatment.
144
145
146				=head2 TreatmentName => Str
147
148				The custom name of a variation of the campaign used for A/B testing.
149
150
151				=head2 Version => Int
152
153				The campaign version number.
154
155
156
157				=head1 SEE ALSO
158
159				This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
160
161				=head1 BUGS and CONTRIBUTIONS
162
163				The source code is located here: https://github.com/pplu/aws-sdk-perl
164
165				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
166
167				=cut
168