« blib/lib/Paws/CloudSearchDomain/Suggest.pm
↑ Summary
blib/lib/Paws/CloudSearchDomain/SuggestResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearchDomain::SuggestModel; | ||
| 3 | use Moose; | ||
| 4 | has Found => (is => 'ro', isa => 'Int', request_name => 'found', traits => ['NameInRequest']); | ||
| 5 | has Query => (is => 'ro', isa => 'Str', request_name => 'query', traits => ['NameInRequest']); | ||
| 6 | has Suggestions => (is => 'ro', isa => 'ArrayRef[Paws::CloudSearchDomain::SuggestionMatch]', request_name => 'suggestions', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CloudSearchDomain::SuggestModel | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::CloudSearchDomain::SuggestModel object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Found => $value, ..., Suggestions => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearchDomain::SuggestModel object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Found | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Container for the suggestion information returned in a | ||
| 39 | C<SuggestResponse>. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Found => Int | ||
| 45 | |||
| 46 | The number of documents that were found to match the query string. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Query => Str | ||
| 50 | |||
| 51 | The query string specified in the suggest request. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Suggestions => ArrayRef[L<Paws::CloudSearchDomain::SuggestionMatch>] | ||
| 55 | |||
| 56 | The documents that match the query string. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head1 SEE ALSO | ||
| 61 | |||
| 62 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearchDomain> | ||
| 63 | |||
| 64 | =head1 BUGS and CONTRIBUTIONS | ||
| 65 | |||
| 66 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 67 | |||
| 68 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 69 | |||
| 70 | =cut | ||
| 71 |