« blib/lib/Paws/LocationService/SearchPlaceIndexForPositionSummary.pm
↑ Summary
blib/lib/Paws/LocationService/SearchPlaceIndexForTextResponse.pm »
| 1 | |||
| 2 | package Paws::LocationService::SearchPlaceIndexForText; | ||
| 3 | use Moose; | ||
| 4 | has BiasPosition => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 5 | has FilterBBox => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 6 | has FilterCountries => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has IndexName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IndexName', required => 1); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 9 | has Text => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchPlaceIndexForText'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/places/v0/indexes/{IndexName}/search/text'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::SearchPlaceIndexForTextResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::LocationService::SearchPlaceIndexForText - Arguments for method SearchPlaceIndexForText on L<Paws::LocationService> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method SearchPlaceIndexForText on the | ||
| 28 | L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class | ||
| 29 | as arguments to method SearchPlaceIndexForText. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchPlaceIndexForText. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $geo = Paws->service('LocationService'); | ||
| 36 | my $SearchPlaceIndexForTextResponse = $geo->SearchPlaceIndexForText( | ||
| 37 | IndexName => 'MyResourceName', | ||
| 38 | Text => 'MySyntheticSearchPlaceIndexForTextRequestString', | ||
| 39 | BiasPosition => [ 1, ... ], # OPTIONAL | ||
| 40 | FilterBBox => [ 1, ... ], # OPTIONAL | ||
| 41 | FilterCountries => [ 'MyCountryCode', ... ], # OPTIONAL | ||
| 42 | MaxResults => 1, # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Results = $SearchPlaceIndexForTextResponse->Results; | ||
| 47 | my $Summary = $SearchPlaceIndexForTextResponse->Summary; | ||
| 48 | |||
| 49 | # Returns a L<Paws::LocationService::SearchPlaceIndexForTextResponse> object. | ||
| 50 | |||
| 51 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/geo/SearchPlaceIndexForText> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 BiasPosition => ArrayRef[Num] | ||
| 58 | |||
| 59 | Searches for results closest to the given position. An optional | ||
| 60 | parameter defined by longitude, and latitude. | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | The first C<bias> position is the X coordinate, or longitude. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | The second C<bias> position is the Y coordinate, or latitude. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | For example, C<bias=xLongitude&bias=yLatitude>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 FilterBBox => ArrayRef[Num] | ||
| 79 | |||
| 80 | Filters the results by returning only Places within the provided | ||
| 81 | bounding box. An optional parameter. | ||
| 82 | |||
| 83 | The first 2 C<bbox> parameters describe the lower southwest corner: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | The first C<bbox> position is the X coordinate or longitude of the | ||
| 90 | lower southwest corner. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | The second C<bbox> position is the Y coordinate or latitude of the | ||
| 95 | lower southwest corner. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | For example, C<bbox=xLongitudeSW&bbox=yLatitudeSW>. | ||
| 100 | |||
| 101 | The next C<bbox> parameters describe the upper northeast corner: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | The third C<bbox> position is the X coordinate, or longitude of the | ||
| 108 | upper northeast corner. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | The fourth C<bbox> position is the Y coordinate, or longitude of the | ||
| 113 | upper northeast corner. | ||
| 114 | |||
| 115 | =back | ||
| 116 | |||
| 117 | For example, C<bbox=xLongitudeNE&bbox=yLatitudeNE> | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 FilterCountries => ArrayRef[Str|Undef] | ||
| 122 | |||
| 123 | Limits the search to the given a list of countries/regions. An optional | ||
| 124 | parameter. | ||
| 125 | |||
| 126 | =over | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | Use the ISO 3166 (https://www.iso.org/iso-3166-country-codes.html) | ||
| 131 | 3-digit country code. For example, Australia uses three upper-case | ||
| 132 | characters: C<AUS>. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> IndexName => Str | ||
| 140 | |||
| 141 | The name of the place index resource you want to use for the search. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 MaxResults => Int | ||
| 146 | |||
| 147 | An optional parameter. The maximum number of results returned per | ||
| 148 | request. | ||
| 149 | |||
| 150 | The default: C<50> | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 B<REQUIRED> Text => Str | ||
| 155 | |||
| 156 | The address, name, city, or region to be used in the search. In | ||
| 157 | free-form text format. For example, C<123 Any Street>. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head1 SEE ALSO | ||
| 163 | |||
| 164 | This class forms part of L<Paws>, documenting arguments for method SearchPlaceIndexForText in L<Paws::LocationService> | ||
| 165 | |||
| 166 | =head1 BUGS and CONTRIBUTIONS | ||
| 167 | |||
| 168 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 169 | |||
| 170 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 171 | |||
| 172 | =cut | ||
| 173 |