File Coverage

blib/lib/Paws/CloudSearchDomain/Hits.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::CloudSearchDomain::Hits;
2 1     1   432 use Moose;
  1         3  
  1         8  
3             has Cursor => (is => 'ro', isa => 'Str', request_name => 'cursor', traits => ['NameInRequest']);
4             has Found => (is => 'ro', isa => 'Int', request_name => 'found', traits => ['NameInRequest']);
5             has Hit => (is => 'ro', isa => 'ArrayRef[Paws::CloudSearchDomain::Hit]', request_name => 'hit', traits => ['NameInRequest']);
6             has Start => (is => 'ro', isa => 'Int', request_name => 'start', traits => ['NameInRequest']);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CloudSearchDomain::Hits
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::CloudSearchDomain::Hits object:
25              
26             $service_obj->Method(Att1 => { Cursor => $value, ..., Start => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearchDomain::Hits object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Cursor
34              
35             =head1 DESCRIPTION
36              
37             The collection of documents that match the search request.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 Cursor => Str
43              
44             A cursor that can be used to retrieve the next set of matching
45             documents when you want to page through a large result set.
46              
47              
48             =head2 Found => Int
49              
50             The total number of documents that match the search request.
51              
52              
53             =head2 Hit => ArrayRef[L<Paws::CloudSearchDomain::Hit>]
54              
55             A document that matches the search request.
56              
57              
58             =head2 Start => Int
59              
60             The index of the first matching document.
61              
62              
63              
64             =head1 SEE ALSO
65              
66             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearchDomain>
67              
68             =head1 BUGS and CONTRIBUTIONS
69              
70             The source code is located here: https://github.com/pplu/aws-sdk-perl
71              
72             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
73              
74             =cut
75