File Coverage

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