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

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 16 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::EndpointBatchItem;
3 use Moose;
4 has Address => (is => 'ro', isa => 'Str');
5 has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
6 has ChannelType => (is => 'ro', isa => 'Str');
7 has Demographic => (is => 'ro', isa => 'Paws::Pinpoint::EndpointDemographic');
8 has EffectiveDate => (is => 'ro', isa => 'Str');
9 has EndpointStatus => (is => 'ro', isa => 'Str');
10 has Id => (is => 'ro', isa => 'Str');
11 has Location => (is => 'ro', isa => 'Paws::Pinpoint::EndpointLocation');
12 has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__double');
13 has OptOut => (is => 'ro', isa => 'Str');
14 has RequestId => (is => 'ro', isa => 'Str');
15 has User => (is => 'ro', isa => 'Paws::Pinpoint::EndpointUser');
16  
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Pinpoint::EndpointBatchItem
24  
25 =head1 USAGE
26  
27 This class represents one of two things:
28  
29 =head3 Arguments in a call to a service
30  
31 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32 Each attribute should be used as a named argument in the calls that expect this type of object.
33  
34 As an example, if Att1 is expected to be a Paws::Pinpoint::EndpointBatchItem object:
35  
36 $service_obj->Method(Att1 => { Address => $value, ..., User => $value });
37  
38 =head3 Results returned from an API call
39  
40 Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EndpointBatchItem object:
41  
42 $result = $service_obj->Method(...);
43 $result->Att1->Address
44  
45 =head1 DESCRIPTION
46  
47 Specifies an endpoint to create or update and the settings and
48 attributes to set or change for the endpoint.
49  
50 =head1 ATTRIBUTES
51  
52  
53 =head2 Address => Str
54  
55 The destination address for messages or push notifications that you
56 send to the endpoint. The address varies by channel. For a
57 push-notification channel, use the token provided by the push
58 notification service, such as an Apple Push Notification service (APNs)
59 device token or a Firebase Cloud Messaging (FCM) registration token.
60 For the SMS channel, use a phone number in E.164 format, such as
61 +12065550100. For the email channel, use an email address.
62  
63  
64 =head2 Attributes => L<Paws::Pinpoint::MapOfListOf__string>
65  
66 One or more custom attributes that describe the endpoint by associating
67 a name with an array of values. For example, the value of a custom
68 attribute named Interests might be: ["Science", "Music", "Travel"]. You
69 can use these attributes as filter criteria when you create segments.
70 Attribute names are case sensitive.
71  
72 An attribute name can contain up to 50 characters. An attribute value
73 can contain up to 100 characters. When you define the name of a custom
74 attribute, avoid using the following characters: number sign (#), colon
75 (:), question mark (?), backslash (\), and slash (/). The Amazon
76 Pinpoint console can't display attribute names that contain these
77 characters. This restriction doesn't apply to attribute values.
78  
79  
80 =head2 ChannelType => Str
81  
82 The channel to use when sending messages or push notifications to the
83 endpoint.
84  
85  
86 =head2 Demographic => L<Paws::Pinpoint::EndpointDemographic>
87  
88 The demographic information for the endpoint, such as the time zone and
89 platform.
90  
91  
92 =head2 EffectiveDate => Str
93  
94 The date and time, in ISO 8601 format, when the endpoint was created or
95 updated.
96  
97  
98 =head2 EndpointStatus => Str
99  
100 Specifies whether to send messages or push notifications to the
101 endpoint. Valid values are: ACTIVE, messages are sent to the endpoint;
102 and, INACTIVE, messages arenE<rsquo>t sent to the endpoint.
103  
104 Amazon Pinpoint automatically sets this value to ACTIVE when you create
105 an endpoint or update an existing endpoint. Amazon Pinpoint
106 automatically sets this value to INACTIVE if you update another
107 endpoint that has the same address specified by the Address property.
108  
109  
110 =head2 Id => Str
111  
112 The unique identifier for the endpoint in the context of the batch.
113  
114  
115 =head2 Location => L<Paws::Pinpoint::EndpointLocation>
116  
117 The geographic information for the endpoint.
118  
119  
120 =head2 Metrics => L<Paws::Pinpoint::MapOf__double>
121  
122 One or more custom metrics that your app reports to Amazon Pinpoint for
123 the endpoint.
124  
125  
126 =head2 OptOut => Str
127  
128 Specifies whether the user who's associated with the endpoint has opted
129 out of receiving messages and push notifications from you. Possible
130 values are: ALL, the user has opted out and doesn't want to receive any
131 messages or push notifications; and, NONE, the user hasn't opted out
132 and wants to receive all messages and push notifications.
133  
134  
135 =head2 RequestId => Str
136  
137 The unique identifier for the request to create or update the endpoint.
138  
139  
140 =head2 User => L<Paws::Pinpoint::EndpointUser>
141  
142 One or more custom attributes that describe the user who's associated
143 with the endpoint.
144  
145  
146  
147 =head1 SEE ALSO
148  
149 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
150  
151 =head1 BUGS and CONTRIBUTIONS
152  
153 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
154  
155 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
156  
157 =cut
158