« blib/lib/Paws/LocationService/SearchPlaceIndexForTextResponse.pm
↑ Summary
blib/lib/Paws/LocationService/Step.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LocationService::SearchPlaceIndexForTextSummary; | ||
| 3 | use Moose; | ||
| 4 | has BiasPosition => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 5 | has DataSource => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FilterBBox => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 7 | has FilterCountries => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 9 | has ResultBBox => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 10 | has Text => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::LocationService::SearchPlaceIndexForTextSummary | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::LocationService::SearchPlaceIndexForTextSummary object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { BiasPosition => $value, ..., Text => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::LocationService::SearchPlaceIndexForTextSummary object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->BiasPosition | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | A summary of the geocoding request sent using | ||
| 43 | C<SearchPlaceIndexForText>. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 BiasPosition => ArrayRef[Num] | ||
| 49 | |||
| 50 | Contains the coordinates for the bias position entered in the geocoding | ||
| 51 | request. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> DataSource => Str | ||
| 55 | |||
| 56 | The data provider of geospatial data. Indicates one of the available | ||
| 57 | providers: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | Esri | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | HERE | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | For additional details on data providers, see the Amazon Location | ||
| 72 | Service data providers page | ||
| 73 | (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). | ||
| 74 | |||
| 75 | |||
| 76 | =head2 FilterBBox => ArrayRef[Num] | ||
| 77 | |||
| 78 | Contains the coordinates for the optional bounding box coordinated | ||
| 79 | entered in the geocoding request. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 FilterCountries => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | Contains the country filter entered in the geocoding request. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 MaxResults => Int | ||
| 88 | |||
| 89 | Contains the maximum number of results indicated for the request. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ResultBBox => ArrayRef[Num] | ||
| 93 | |||
| 94 | A bounding box that contains the search results within the specified | ||
| 95 | area indicated by C<FilterBBox>. A subset of bounding box specified | ||
| 96 | using C<FilterBBox>. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Text => Str | ||
| 100 | |||
| 101 | The address, name, city or region to be used in the geocoding request. | ||
| 102 | In free-form text format. For example, C<Vancouver>. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::LocationService> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |