« blib/lib/Paws/Kendra/GoogleDriveConfiguration.pm
↑ Summary
blib/lib/Paws/Kendra/IndexConfigurationSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::Highlight; | ||
| 3 | use Moose; | ||
| 4 | has BeginOffset => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has EndOffset => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has TopAnswer => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Type => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Kendra::Highlight | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Kendra::Highlight object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { BeginOffset => $value, ..., Type => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Highlight object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->BeginOffset | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Provides information that you can use to highlight a search result so | ||
| 40 | that your users can quickly identify terms in the response. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> BeginOffset => Int | ||
| 46 | |||
| 47 | The zero-based location in the response string where the highlight | ||
| 48 | starts. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> EndOffset => Int | ||
| 52 | |||
| 53 | The zero-based location in the response string where the highlight | ||
| 54 | ends. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 TopAnswer => Bool | ||
| 58 | |||
| 59 | Indicates whether the response is the best response. True if this is | ||
| 60 | the best response; otherwise, false. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Type => Str | ||
| 64 | |||
| 65 | The highlight type. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |