File Coverage

blib/lib/Paws/S3/IndexDocument.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::S3::IndexDocument;
2 1     1   279 use Moose;
  1         2  
  1         6  
3             has Suffix => (is => 'ro', isa => 'Str', required => 1);
4             1;
5              
6             ### main pod documentation begin ###
7              
8             =head1 NAME
9              
10             Paws::S3::IndexDocument
11              
12             =head1 USAGE
13              
14             This class represents one of two things:
15              
16             =head3 Arguments in a call to a service
17              
18             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
19             Each attribute should be used as a named argument in the calls that expect this type of object.
20              
21             As an example, if Att1 is expected to be a Paws::S3::IndexDocument object:
22              
23             $service_obj->Method(Att1 => { Suffix => $value, ..., Suffix => $value });
24              
25             =head3 Results returned from an API call
26              
27             Use accessors for each attribute. If Att1 is expected to be an Paws::S3::IndexDocument object:
28              
29             $result = $service_obj->Method(...);
30             $result->Att1->Suffix
31              
32             =head1 DESCRIPTION
33              
34             This class has no description
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> Suffix => Str
40              
41             A suffix that is appended to a request that is for a directory on the
42             website endpoint (e.g. if the suffix is index.html and you make a
43             request to samplebucket/images/ the data that is returned will be for
44             the object with the key name images/index.html) The suffix must not be
45             empty and must not include a slash character.
46              
47              
48              
49             =head1 SEE ALSO
50              
51             This class forms part of L<Paws>, describing an object used in L<Paws::S3>
52              
53             =head1 BUGS and CONTRIBUTIONS
54              
55             The source code is located here: https://github.com/pplu/aws-sdk-perl
56              
57             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
58              
59             =cut
60