File Coverage

blib/lib/Paws/WorkDocs/DeleteCustomMetadata.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::DeleteCustomMetadata;
3 1     1   525 use Moose;
  1         3  
  1         8  
4             has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication' );
5             has DeleteAll => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'deleteAll' );
6             has Keys => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'keys' );
7             has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ResourceId' , required => 1);
8             has VersionId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'versionId' );
9              
10 1     1   6736 use MooseX::ClassAttribute;
  1         3  
  1         10  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteCustomMetadata');
13             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/resources/{ResourceId}/customMetadata');
14             class_has _api_method => (isa => 'Str', is => 'ro', default => 'DELETE');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DeleteCustomMetadataResponse');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::WorkDocs::DeleteCustomMetadata - Arguments for method DeleteCustomMetadata on Paws::WorkDocs
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method DeleteCustomMetadata on the
28             Amazon WorkDocs service. Use the attributes of this class
29             as arguments to method DeleteCustomMetadata.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteCustomMetadata.
32              
33             As an example:
34              
35             $service_obj->DeleteCustomMetadata(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 AuthenticationToken => Str
43              
44             Amazon WorkDocs authentication token. This field should not be set when
45             using administrative API actions, as in accessing the API using AWS
46             credentials.
47              
48              
49              
50             =head2 DeleteAll => Bool
51              
52             Flag to indicate removal of all custom metadata properties from the
53             specified resource.
54              
55              
56              
57             =head2 Keys => ArrayRef[Str|Undef]
58              
59             List of properties to remove.
60              
61              
62              
63             =head2 B<REQUIRED> ResourceId => Str
64              
65             The ID of the resource, either a document or folder.
66              
67              
68              
69             =head2 VersionId => Str
70              
71             The ID of the version, if the custom metadata is being deleted from a
72             document version.
73              
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, documenting arguments for method DeleteCustomMetadata in L<Paws::WorkDocs>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88