File Coverage

blib/lib/Paws/CloudSearchDomain/Hit.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::Hit;
2 1     1   300 use Moose;
  1         3  
  1         5  
3             has Exprs => (is => 'ro', isa => 'Paws::CloudSearchDomain::Exprs', request_name => 'exprs', traits => ['NameInRequest']);
4             has Fields => (is => 'ro', isa => 'Paws::CloudSearchDomain::Fields', request_name => 'fields', traits => ['NameInRequest']);
5             has Highlights => (is => 'ro', isa => 'Paws::CloudSearchDomain::Highlights', request_name => 'highlights', traits => ['NameInRequest']);
6             has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CloudSearchDomain::Hit
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::Hit object:
25              
26             $service_obj->Method(Att1 => { Exprs => $value, ..., Id => $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::Hit object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Exprs
34              
35             =head1 DESCRIPTION
36              
37             Information about a document that matches the search request.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 Exprs => L<Paws::CloudSearchDomain::Exprs>
43              
44             The expressions returned from a document that matches the search
45             request.
46              
47              
48             =head2 Fields => L<Paws::CloudSearchDomain::Fields>
49              
50             The fields returned from a document that matches the search request.
51              
52              
53             =head2 Highlights => L<Paws::CloudSearchDomain::Highlights>
54              
55             The highlights returned from a document that matches the search
56             request.
57              
58              
59             =head2 Id => Str
60              
61             The document ID of a document that matches the search request.
62              
63              
64              
65             =head1 SEE ALSO
66              
67             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearchDomain>
68              
69             =head1 BUGS and CONTRIBUTIONS
70              
71             The source code is located here: https://github.com/pplu/aws-sdk-perl
72              
73             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
74              
75             =cut
76