Class: Aws::GeoRoutes::Types::CalculateRoutesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::GeoRoutes::Types::CalculateRoutesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-georoutes/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:destination, :key, :origin]
Instance Attribute Summary collapse
-
#allow ⇒ Types::RouteAllowOptions
Features that are allowed while calculating.
-
#arrival_time ⇒ String
Time of arrival at the destination.
-
#avoid ⇒ Types::RouteAvoidanceOptions
Features that are avoided while calculating a route.
-
#depart_now ⇒ Boolean
Uses the current time as the time of departure.
-
#departure_time ⇒ String
Time of departure from thr origin.
-
#destination ⇒ Array<Float>
The final position for the route.
-
#destination_options ⇒ Types::RouteDestinationOptions
Destination related options.
-
#driver ⇒ Types::RouteDriverOptions
Driver related options.
-
#exclude ⇒ Types::RouteExclusionOptions
Features to be strictly excluded while calculating the route.
-
#instructions_measurement_system ⇒ String
Measurement system to be used for instructions within steps in the response.
-
#key ⇒ String
Optional: The API key to be used for authorization.
-
#languages ⇒ Array<String>
List of languages for instructions within steps in the response.
-
#leg_additional_features ⇒ Array<String>
A list of optional additional parameters such as timezone that can be requested for each result.
-
#leg_geometry_format ⇒ String
Specifies the format of the geometry returned for each leg of the route.
-
#max_alternatives ⇒ Integer
Maximum number of alternative routes to be provided in the response, if available.
-
#optimize_routing_for ⇒ String
Specifies the optimization criteria for calculating a route.
-
#origin ⇒ Array<Float>
The start position for the route.
-
#origin_options ⇒ Types::RouteOriginOptions
Origin related options.
-
#span_additional_features ⇒ Array<String>
A list of optional features such as SpeedLimit that can be requested for a Span.
-
#tolls ⇒ Types::RouteTollOptions
Toll related options.
-
#traffic ⇒ Types::RouteTrafficOptions
Traffic related options.
-
#travel_mode ⇒ String
Specifies the mode of transport when calculating a route.
-
#travel_mode_options ⇒ Types::RouteTravelModeOptions
Travel mode related options for the provided travel mode.
-
#travel_step_type ⇒ String
Type of step returned by the response.
-
#waypoints ⇒ Array<Types::RouteWaypoint>
List of waypoints between the Origin and Destination.
Instance Attribute Details
#allow ⇒ Types::RouteAllowOptions
Features that are allowed while calculating. a route
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#arrival_time ⇒ String
Time of arrival at the destination.
Time format:‘YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm`
Examples:
‘2020-04-22T17:57:24Z`
‘2020-04-22T17:57:24+02:00`
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#avoid ⇒ Types::RouteAvoidanceOptions
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#depart_now ⇒ Boolean
Uses the current time as the time of departure.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#departure_time ⇒ String
Time of departure from thr origin.
Time format:‘YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm`
Examples:
‘2020-04-22T17:57:24Z`
‘2020-04-22T17:57:24+02:00`
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#destination ⇒ Array<Float>
The final position for the route. In the World Geodetic System (WGS 84) format: ‘[longitude, latitude]`.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#destination_options ⇒ Types::RouteDestinationOptions
Destination related options.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#driver ⇒ Types::RouteDriverOptions
Driver related options.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#exclude ⇒ Types::RouteExclusionOptions
Features to be strictly excluded while calculating the route.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#instructions_measurement_system ⇒ String
Measurement system to be used for instructions within steps in the response.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#key ⇒ String
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#languages ⇒ Array<String>
List of languages for instructions within steps in the response.
<note markdown=“1”> Instructions in the requested language are returned only if they are available.
</note>
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#leg_additional_features ⇒ Array<String>
A list of optional additional parameters such as timezone that can be requested for each result.
-
‘Elevation`: Retrieves the elevation information for each location.
-
‘Incidents`: Provides information on traffic incidents along the route.
-
‘PassThroughWaypoints`: Indicates waypoints that are passed through without stopping.
-
‘Summary`: Returns a summary of the route, including distance and duration.
-
‘Tolls`: Supplies toll cost information along the route.
-
‘TravelStepInstructions`: Provides step-by-step instructions for travel along the route.
-
‘TruckRoadTypes`: Returns information about road types suitable for trucks.
-
‘TypicalDuration`: Gives typical travel duration based on historical data.
-
‘Zones`: Specifies the time zone information for each waypoint.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#leg_geometry_format ⇒ String
Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.
‘FlexiblePolyline`: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for [ `FlexiblePolyline` ][1].
‘Simple`: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#max_alternatives ⇒ Integer
Maximum number of alternative routes to be provided in the response, if available.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#optimize_routing_for ⇒ String
Specifies the optimization criteria for calculating a route.
Default Value: ‘FastestRoute`
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#origin ⇒ Array<Float>
The start position for the route.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#origin_options ⇒ Types::RouteOriginOptions
Origin related options.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#span_additional_features ⇒ Array<String>
A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#tolls ⇒ Types::RouteTollOptions
Toll related options.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#traffic ⇒ Types::RouteTrafficOptions
Traffic related options.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#travel_mode ⇒ String
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: ‘Car`
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#travel_mode_options ⇒ Types::RouteTravelModeOptions
Travel mode related options for the provided travel mode.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#travel_step_type ⇒ String
Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based naviagtion system.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#waypoints ⇒ Array<Types::RouteWaypoint>
List of waypoints between the Origin and Destination.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-georoutes/types.rb', line 547 class CalculateRoutesRequest < Struct.new( :allow, :arrival_time, :avoid, :depart_now, :departure_time, :destination, :destination_options, :driver, :exclude, :instructions_measurement_system, :key, :languages, :leg_additional_features, :leg_geometry_format, :max_alternatives, :optimize_routing_for, :origin, :origin_options, :span_additional_features, :tolls, :traffic, :travel_mode, :travel_mode_options, :travel_step_type, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |