« blib/lib/Paws/LocationService/CalculateRouteCarModeOptions.pm
↑ Summary
blib/lib/Paws/LocationService/CalculateRouteSummary.pm »
| 1 | |||
| 2 | package Paws::LocationService::CalculateRouteResponse; | ||
| 3 | use Moose; | ||
| 4 | has Legs => (is => 'ro', isa => 'ArrayRef[Paws::LocationService::Leg]', required => 1); | ||
| 5 | has Summary => (is => 'ro', isa => 'Paws::LocationService::CalculateRouteSummary', required => 1); | ||
| 6 | |||
| 7 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LocationService::CalculateRouteResponse | ||
| 15 | |||
| 16 | =head1 ATTRIBUTES | ||
| 17 | |||
| 18 | |||
| 19 | =head2 B<REQUIRED> Legs => ArrayRef[L<Paws::LocationService::Leg>] | ||
| 20 | |||
| 21 | Contains details about each path between a pair of positions included | ||
| 22 | along a route such as: C<StartPosition>, C<EndPosition>, C<Distance>, | ||
| 23 | C<DurationSeconds>, C<Geometry>, and C<Steps>. The number of legs | ||
| 24 | returned corresponds to one less than the total number of positions in | ||
| 25 | the request. | ||
| 26 | |||
| 27 | For example, a route with a departure position and destination position | ||
| 28 | returns one leg with the positions snapped to a nearby road | ||
| 29 | (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road): | ||
| 30 | |||
| 31 | =over | ||
| 32 | |||
| 33 | =item * | ||
| 34 | |||
| 35 | The C<StartPosition> is the departure position. | ||
| 36 | |||
| 37 | =item * | ||
| 38 | |||
| 39 | The C<EndPosition> is the destination position. | ||
| 40 | |||
| 41 | =back | ||
| 42 | |||
| 43 | A route with a waypoint between the departure and destination position | ||
| 44 | returns two legs with the positions snapped to a nearby road.: | ||
| 45 | |||
| 46 | =over | ||
| 47 | |||
| 48 | =item * | ||
| 49 | |||
| 50 | Leg 1: The C<StartPosition> is the departure position . The | ||
| 51 | C<EndPosition> is the waypoint positon. | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | Leg 2: The C<StartPosition> is the waypoint position. The | ||
| 56 | C<EndPosition> is the destination position. | ||
| 57 | |||
| 58 | =back | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Summary => L<Paws::LocationService::CalculateRouteSummary> | ||
| 63 | |||
| 64 | Contains information about the whole route, such as: C<RouteBBox>, | ||
| 65 | C<DataSource>, C<Distance>, C<DistanceUnit>, and C<DurationSeconds> | ||
| 66 | |||
| 67 | |||
| 68 | =head2 _request_id => Str | ||
| 69 | |||
| 70 | |||
| 71 | =cut | ||
| 72 |