File Coverage

blib/lib/Paws/WorkDocs/CreateNotificationSubscription.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::WorkDocs::CreateNotificationSubscription;
3 1     1   270 use Moose;
  1         5  
  1         7  
4             has Endpoint => (is => 'ro', isa => 'Str', required => 1);
5             has OrganizationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'OrganizationId' , required => 1);
6             has Protocol => (is => 'ro', isa => 'Str', required => 1);
7             has SubscriptionType => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   5449 use MooseX::ClassAttribute;
  1         3  
  1         8  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNotificationSubscription');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/organizations/{OrganizationId}/subscriptions');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::CreateNotificationSubscriptionResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::WorkDocs::CreateNotificationSubscription - Arguments for method CreateNotificationSubscription on Paws::WorkDocs
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CreateNotificationSubscription on the
27             Amazon WorkDocs service. Use the attributes of this class
28             as arguments to method CreateNotificationSubscription.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotificationSubscription.
31              
32             As an example:
33              
34             $service_obj->CreateNotificationSubscription(Att1 => $value1, Att2 => $value2, ...);
35              
36             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> Endpoint => Str
42              
43             The endpoint to receive the notifications. If the protocol is HTTPS,
44             the endpoint is a URL that begins with "https://".
45              
46              
47              
48             =head2 B<REQUIRED> OrganizationId => Str
49              
50             The ID of the organization.
51              
52              
53              
54             =head2 B<REQUIRED> Protocol => Str
55              
56             The protocol to use. The supported value is https, which delivers
57             JSON-encoded messasges using HTTPS POST.
58              
59             Valid values are: C<"HTTPS">
60              
61             =head2 B<REQUIRED> SubscriptionType => Str
62              
63             The notification type.
64              
65             Valid values are: C<"ALL">
66              
67              
68             =head1 SEE ALSO
69              
70             This class forms part of L<Paws>, documenting arguments for method CreateNotificationSubscription in L<Paws::WorkDocs>
71              
72             =head1 BUGS and CONTRIBUTIONS
73              
74             The source code is located here: https://github.com/pplu/aws-sdk-perl
75              
76             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
77              
78             =cut
79