File Coverage

blib/lib/Paws/Pinpoint/EndpointBatchItem.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::EndpointBatchItem;
2 1     1   431 use Moose;
  1         3  
  1         9  
3             has Address => (is => 'ro', isa => 'Str');
4             has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
5             has ChannelType => (is => 'ro', isa => 'Str');
6             has Demographic => (is => 'ro', isa => 'Paws::Pinpoint::EndpointDemographic');
7             has EffectiveDate => (is => 'ro', isa => 'Str');
8             has EndpointStatus => (is => 'ro', isa => 'Str');
9             has Id => (is => 'ro', isa => 'Str');
10             has Location => (is => 'ro', isa => 'Paws::Pinpoint::EndpointLocation');
11             has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__double');
12             has OptOut => (is => 'ro', isa => 'Str');
13             has RequestId => (is => 'ro', isa => 'Str');
14             has User => (is => 'ro', isa => 'Paws::Pinpoint::EndpointUser');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::Pinpoint::EndpointBatchItem
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::EndpointBatchItem object:
33              
34             $service_obj->Method(Att1 => { Address => $value, ..., User => $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::EndpointBatchItem object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->Address
42              
43             =head1 DESCRIPTION
44              
45             Endpoint update request
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 Address => Str
51              
52             The address or token of the endpoint as provided by your push provider
53             (e.g. DeviceToken or RegistrationId).
54              
55              
56             =head2 Attributes => L<Paws::Pinpoint::MapOfListOf__string>
57              
58             Custom attributes that your app reports to Amazon Pinpoint. You can use
59             these attributes as selection criteria when you create a segment.
60              
61              
62             =head2 ChannelType => Str
63              
64             The channel type. Valid values: GCM | APNS | SMS | EMAIL
65              
66              
67             =head2 Demographic => L<Paws::Pinpoint::EndpointDemographic>
68              
69             The endpoint demographic attributes.
70              
71              
72             =head2 EffectiveDate => Str
73              
74             The last time the endpoint was updated. Provided in ISO 8601 format.
75              
76              
77             =head2 EndpointStatus => Str
78              
79             The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to
80             INACTIVE if a delivery fails. Will be set to ACTIVE if the address is
81             updated.
82              
83              
84             =head2 Id => Str
85              
86             The unique Id for the Endpoint in the batch.
87              
88              
89             =head2 Location => L<Paws::Pinpoint::EndpointLocation>
90              
91             The endpoint location attributes.
92              
93              
94             =head2 Metrics => L<Paws::Pinpoint::MapOf__double>
95              
96             Custom metrics that your app reports to Amazon Pinpoint.
97              
98              
99             =head2 OptOut => Str
100              
101             Indicates whether a user has opted out of receiving messages with one
102             of the following values: ALL - User has opted out of all messages. NONE
103             - Users has not opted out and receives all messages.
104              
105              
106             =head2 RequestId => Str
107              
108             The unique ID for the most recent request to update the endpoint.
109              
110              
111             =head2 User => L<Paws::Pinpoint::EndpointUser>
112              
113             Custom user-specific attributes that your app reports to Amazon
114             Pinpoint.
115              
116              
117              
118             =head1 SEE ALSO
119              
120             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
121              
122             =head1 BUGS and CONTRIBUTIONS
123              
124             The source code is located here: https://github.com/pplu/aws-sdk-perl
125              
126             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
127              
128             =cut
129