« blib/lib/Paws/LocationService/MapConfiguration.pm
↑ Summary
blib/lib/Paws/LocationService/PlaceGeometry.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LocationService::Place; | ||
| 3 | use Moose; | ||
| 4 | has AddressNumber => (is => 'ro', isa => 'Str'); | ||
| 5 | has Country => (is => 'ro', isa => 'Str'); | ||
| 6 | has Geometry => (is => 'ro', isa => 'Paws::LocationService::PlaceGeometry', required => 1); | ||
| 7 | has Label => (is => 'ro', isa => 'Str'); | ||
| 8 | has Municipality => (is => 'ro', isa => 'Str'); | ||
| 9 | has Neighborhood => (is => 'ro', isa => 'Str'); | ||
| 10 | has PostalCode => (is => 'ro', isa => 'Str'); | ||
| 11 | has Region => (is => 'ro', isa => 'Str'); | ||
| 12 | has Street => (is => 'ro', isa => 'Str'); | ||
| 13 | has SubRegion => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LocationService::Place | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::LocationService::Place object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { AddressNumber => $value, ..., SubRegion => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::LocationService::Place object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->AddressNumber | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Contains details about addresses or points of interest that match the | ||
| 46 | search criteria. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AddressNumber => Str | ||
| 52 | |||
| 53 | The numerical portion of an address, such as a building number. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Country => Str | ||
| 57 | |||
| 58 | A country/region specified using ISO 3166 | ||
| 59 | (https://www.iso.org/iso-3166-country-codes.html) 3-digit | ||
| 60 | country/region code. For example, C<CAN>. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Geometry => L<Paws::LocationService::PlaceGeometry> | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Label => Str | ||
| 69 | |||
| 70 | The full name and address of the point of interest such as a city, | ||
| 71 | region, or country. For example, C<123 Any Street, Any Town, USA>. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Municipality => Str | ||
| 75 | |||
| 76 | A name for a local area, such as a city or town name. For example, | ||
| 77 | C<Toronto>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Neighborhood => Str | ||
| 81 | |||
| 82 | The name of a community district. For example, C<Downtown>. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 PostalCode => Str | ||
| 86 | |||
| 87 | A group of numbers and letters in a country-specific format, which | ||
| 88 | accompanies the address for the purpose of identifying a location. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Region => Str | ||
| 92 | |||
| 93 | A name for an area or geographical division, such as a province or | ||
| 94 | state name. For example, C<British Columbia>. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Street => Str | ||
| 98 | |||
| 99 | The name for a street or a road to identify a location. For example, | ||
| 100 | C<Main Street>. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 SubRegion => Str | ||
| 104 | |||
| 105 | A country, or an area that's part of a larger region . For example, | ||
| 106 | C<Metro Vancouver>. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, describing an object used in L<Paws::LocationService> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |