File Coverage

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