« blib/lib/Paws/LocationService/SearchPlaceIndexForTextSummary.pm
↑ Summary
blib/lib/Paws/LocationService/TagMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LocationService::Step; | ||
| 3 | use Moose; | ||
| 4 | has Distance => (is => 'ro', isa => 'Num', required => 1); | ||
| 5 | has DurationSeconds => (is => 'ro', isa => 'Num', required => 1); | ||
| 6 | has EndPosition => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); | ||
| 7 | has GeometryOffset => (is => 'ro', isa => 'Int'); | ||
| 8 | has StartPosition => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::LocationService::Step | ||
| 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::Step object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Distance => $value, ..., StartPosition => $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::Step object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Distance | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Represents an element of a leg within a route. A step contains | ||
| 41 | instructions for how to move to the next step in the leg. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> Distance => Num | ||
| 47 | |||
| 48 | The travel distance between the step's C<StartPosition> and | ||
| 49 | C<EndPosition>. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> DurationSeconds => Num | ||
| 53 | |||
| 54 | The estimated travel time, in seconds, from the step's C<StartPosition> | ||
| 55 | to the C<EndPosition>. . The travel mode and departure time that you | ||
| 56 | specify in the request determines the calculated time. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> EndPosition => ArrayRef[Num] | ||
| 60 | |||
| 61 | The end position of a step. If the position the last step in the leg, | ||
| 62 | this position is the same as the end position of the leg. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 GeometryOffset => Int | ||
| 66 | |||
| 67 | Represents the start position, or index, in a sequence of steps within | ||
| 68 | the leg's line string geometry. For example, the index of the first | ||
| 69 | step in a leg geometry is C<0>. | ||
| 70 | |||
| 71 | Included in the response for queries that set C<IncludeLegGeometry> to | ||
| 72 | C<True>. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> StartPosition => ArrayRef[Num] | ||
| 76 | |||
| 77 | The starting position of a step. If the position is the first step in | ||
| 78 | the leg, this position is the same as the start position of the leg. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::LocationService> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |