« blib/lib/Paws/LocationService/CalculateRouteResponse.pm
↑ Summary
blib/lib/Paws/LocationService/CalculateRouteTruckModeOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LocationService::CalculateRouteSummary; | ||
| 3 | use Moose; | ||
| 4 | has DataSource => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Distance => (is => 'ro', isa => 'Num', required => 1); | ||
| 6 | has DistanceUnit => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DurationSeconds => (is => 'ro', isa => 'Num', required => 1); | ||
| 8 | has RouteBBox => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::LocationService::CalculateRouteSummary | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::LocationService::CalculateRouteSummary object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DataSource => $value, ..., RouteBBox => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::LocationService::CalculateRouteSummary object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DataSource | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A summary of the calculated route. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> DataSource => Str | ||
| 46 | |||
| 47 | The data provider of traffic and road network data used to calculate | ||
| 48 | the route. Indicates one of the available providers: | ||
| 49 | |||
| 50 | =over | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | C<Esri> | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<Here> | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | For more information about data providers, see Amazon Location Service | ||
| 63 | data providers | ||
| 64 | (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Distance => Num | ||
| 68 | |||
| 69 | The total distance covered by the route. The sum of the distance | ||
| 70 | travelled between every stop on the route. | ||
| 71 | |||
| 72 | The route C<distance> can't be greater than 250 km. If the route | ||
| 73 | exceeds 250 km, the response returns a C<400 RoutesValidationException> | ||
| 74 | error. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> DistanceUnit => Str | ||
| 78 | |||
| 79 | The unit of measurement for the distance. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DurationSeconds => Num | ||
| 83 | |||
| 84 | The total travel time for the route measured in seconds. The sum of the | ||
| 85 | travel time between every stop on the route. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> RouteBBox => ArrayRef[Num] | ||
| 89 | |||
| 90 | Specifies a geographical box surrounding a route. Used to zoom into a | ||
| 91 | route when displaying it in a map. For example, C<[min x, min y, max x, | ||
| 92 | max y]> | ||
| 93 | |||
| 94 | The first 2 C<bbox> parameters describe the lower southwest corner: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | The first C<bbox> position is the X coordinate or longitude of the | ||
| 101 | lower southwest corner. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | The second C<bbox> position is the Y coordinate or latitude of the | ||
| 106 | lower southwest corner. | ||
| 107 | |||
| 108 | =back | ||
| 109 | |||
| 110 | The next 2 C<bbox> parameters describe the upper northeast corner: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | The third C<bbox> position is the X coordinate, or longitude of the | ||
| 117 | upper northeast corner. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | The fourth C<bbox> position is the Y coordinate, or longitude of the | ||
| 122 | upper northeast corner. | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, describing an object used in L<Paws::LocationService> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |