Interface CalculateRoutesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CalculateRoutesRequest.Builder,CalculateRoutesRequest>, GeoRoutesRequest.Builder, SdkBuilder<CalculateRoutesRequest.Builder,CalculateRoutesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CalculateRoutesRequest
@Mutable @NotThreadSafe public static interface CalculateRoutesRequest.Builder extends GeoRoutesRequest.Builder, SdkPojo, CopyableBuilder<CalculateRoutesRequest.Builder,CalculateRoutesRequest>

  • Method Details

    • allow

      CalculateRoutesRequest.Builder allow(RouteAllowOptions allow)

      Features that are allowed while calculating a route.

      Parameters:
      allow - Features that are allowed while calculating a route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allow

      default CalculateRoutesRequest.Builder allow(Consumer<RouteAllowOptions.Builder> allow)

      Features that are allowed while calculating a route.

      This is a convenience method that creates an instance of the RouteAllowOptions.Builder avoiding the need to create one manually via RouteAllowOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to allow(RouteAllowOptions).

      Parameters:
      allow - a consumer that will call methods on RouteAllowOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • arrivalTime

      CalculateRoutesRequest.Builder arrivalTime(String arrivalTime)

      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

      Parameters:
      arrivalTime - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • avoid

      CalculateRoutesRequest.Builder avoid(RouteAvoidanceOptions avoid)

      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.

      Parameters:
      avoid - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • avoid

      default CalculateRoutesRequest.Builder avoid(Consumer<RouteAvoidanceOptions.Builder> avoid)

      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.

      This is a convenience method that creates an instance of the RouteAvoidanceOptions.Builder avoiding the need to create one manually via RouteAvoidanceOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to avoid(RouteAvoidanceOptions).

      Parameters:
      avoid - a consumer that will call methods on RouteAvoidanceOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • departNow

      CalculateRoutesRequest.Builder departNow(Boolean departNow)

      Uses the current time as the time of departure.

      Parameters:
      departNow - Uses the current time as the time of departure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • departureTime

      CalculateRoutesRequest.Builder departureTime(String departureTime)

      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

      Parameters:
      departureTime - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      CalculateRoutesRequest.Builder destination(Collection<Double> destination)

      The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      destination - The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      CalculateRoutesRequest.Builder destination(Double... destination)

      The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      destination - The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationOptions

      CalculateRoutesRequest.Builder destinationOptions(RouteDestinationOptions destinationOptions)

      Destination related options.

      Parameters:
      destinationOptions - Destination related options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationOptions

      default CalculateRoutesRequest.Builder destinationOptions(Consumer<RouteDestinationOptions.Builder> destinationOptions)

      Destination related options.

      This is a convenience method that creates an instance of the RouteDestinationOptions.Builder avoiding the need to create one manually via RouteDestinationOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationOptions(RouteDestinationOptions).

      Parameters:
      destinationOptions - a consumer that will call methods on RouteDestinationOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • driver

      CalculateRoutesRequest.Builder driver(RouteDriverOptions driver)

      Driver related options.

      Parameters:
      driver - Driver related options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • driver

      default CalculateRoutesRequest.Builder driver(Consumer<RouteDriverOptions.Builder> driver)

      Driver related options.

      This is a convenience method that creates an instance of the RouteDriverOptions.Builder avoiding the need to create one manually via RouteDriverOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to driver(RouteDriverOptions).

      Parameters:
      driver - a consumer that will call methods on RouteDriverOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exclude

      CalculateRoutesRequest.Builder exclude(RouteExclusionOptions exclude)

      Features to be strictly excluded while calculating the route.

      Parameters:
      exclude - Features to be strictly excluded while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclude

      default CalculateRoutesRequest.Builder exclude(Consumer<RouteExclusionOptions.Builder> exclude)

      Features to be strictly excluded while calculating the route.

      This is a convenience method that creates an instance of the RouteExclusionOptions.Builder avoiding the need to create one manually via RouteExclusionOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exclude(RouteExclusionOptions).

      Parameters:
      exclude - a consumer that will call methods on RouteExclusionOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instructionsMeasurementSystem

      CalculateRoutesRequest.Builder instructionsMeasurementSystem(String instructionsMeasurementSystem)

      Measurement system to be used for instructions within steps in the response.

      Parameters:
      instructionsMeasurementSystem - Measurement system to be used for instructions within steps in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instructionsMeasurementSystem

      CalculateRoutesRequest.Builder instructionsMeasurementSystem(MeasurementSystem instructionsMeasurementSystem)

      Measurement system to be used for instructions within steps in the response.

      Parameters:
      instructionsMeasurementSystem - Measurement system to be used for instructions within steps in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • key

      CalculateRoutesRequest.Builder key(String key)

      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

      Parameters:
      key - Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languages

      CalculateRoutesRequest.Builder languages(Collection<String> languages)

      List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

      Parameters:
      languages - List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languages

      CalculateRoutesRequest.Builder languages(String... languages)

      List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

      Parameters:
      languages - List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • legAdditionalFeaturesWithStrings

      CalculateRoutesRequest.Builder legAdditionalFeaturesWithStrings(Collection<String> legAdditionalFeatures)

      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.

      Parameters:
      legAdditionalFeatures - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • legAdditionalFeaturesWithStrings

      CalculateRoutesRequest.Builder legAdditionalFeaturesWithStrings(String... legAdditionalFeatures)

      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.

      Parameters:
      legAdditionalFeatures - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • legAdditionalFeatures

      CalculateRoutesRequest.Builder legAdditionalFeatures(Collection<RouteLegAdditionalFeature> legAdditionalFeatures)

      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.

      Parameters:
      legAdditionalFeatures - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • legAdditionalFeatures

      CalculateRoutesRequest.Builder legAdditionalFeatures(RouteLegAdditionalFeature... legAdditionalFeatures)

      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.

      Parameters:
      legAdditionalFeatures - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • legGeometryFormat

      CalculateRoutesRequest.Builder legGeometryFormat(String legGeometryFormat)

      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 .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      Parameters:
      legGeometryFormat - 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 .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • legGeometryFormat

      CalculateRoutesRequest.Builder legGeometryFormat(GeometryFormat legGeometryFormat)

      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 .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      Parameters:
      legGeometryFormat - 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 .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxAlternatives

      CalculateRoutesRequest.Builder maxAlternatives(Integer maxAlternatives)

      Maximum number of alternative routes to be provided in the response, if available.

      Parameters:
      maxAlternatives - Maximum number of alternative routes to be provided in the response, if available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optimizeRoutingFor

      CalculateRoutesRequest.Builder optimizeRoutingFor(String optimizeRoutingFor)

      Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

      Parameters:
      optimizeRoutingFor - Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • optimizeRoutingFor

      CalculateRoutesRequest.Builder optimizeRoutingFor(RoutingObjective optimizeRoutingFor)

      Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

      Parameters:
      optimizeRoutingFor - Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • origin

      CalculateRoutesRequest.Builder origin(Collection<Double> origin)

      The start position for the route.

      Parameters:
      origin - The start position for the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • origin

      CalculateRoutesRequest.Builder origin(Double... origin)

      The start position for the route.

      Parameters:
      origin - The start position for the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originOptions

      CalculateRoutesRequest.Builder originOptions(RouteOriginOptions originOptions)

      Origin related options.

      Parameters:
      originOptions - Origin related options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originOptions

      default CalculateRoutesRequest.Builder originOptions(Consumer<RouteOriginOptions.Builder> originOptions)

      Origin related options.

      This is a convenience method that creates an instance of the RouteOriginOptions.Builder avoiding the need to create one manually via RouteOriginOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to originOptions(RouteOriginOptions).

      Parameters:
      originOptions - a consumer that will call methods on RouteOriginOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spanAdditionalFeaturesWithStrings

      CalculateRoutesRequest.Builder spanAdditionalFeaturesWithStrings(Collection<String> spanAdditionalFeatures)

      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.

      Parameters:
      spanAdditionalFeatures - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spanAdditionalFeaturesWithStrings

      CalculateRoutesRequest.Builder spanAdditionalFeaturesWithStrings(String... spanAdditionalFeatures)

      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.

      Parameters:
      spanAdditionalFeatures - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spanAdditionalFeatures

      CalculateRoutesRequest.Builder spanAdditionalFeatures(Collection<RouteSpanAdditionalFeature> spanAdditionalFeatures)

      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.

      Parameters:
      spanAdditionalFeatures - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spanAdditionalFeatures

      CalculateRoutesRequest.Builder spanAdditionalFeatures(RouteSpanAdditionalFeature... spanAdditionalFeatures)

      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.

      Parameters:
      spanAdditionalFeatures - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tolls

      CalculateRoutesRequest.Builder tolls(RouteTollOptions tolls)

      Toll related options.

      Parameters:
      tolls - Toll related options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tolls

      default CalculateRoutesRequest.Builder tolls(Consumer<RouteTollOptions.Builder> tolls)

      Toll related options.

      This is a convenience method that creates an instance of the RouteTollOptions.Builder avoiding the need to create one manually via RouteTollOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tolls(RouteTollOptions).

      Parameters:
      tolls - a consumer that will call methods on RouteTollOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • traffic

      CalculateRoutesRequest.Builder traffic(RouteTrafficOptions traffic)

      Traffic related options.

      Parameters:
      traffic - Traffic related options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traffic

      default CalculateRoutesRequest.Builder traffic(Consumer<RouteTrafficOptions.Builder> traffic)

      Traffic related options.

      This is a convenience method that creates an instance of the RouteTrafficOptions.Builder avoiding the need to create one manually via RouteTrafficOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to traffic(RouteTrafficOptions).

      Parameters:
      traffic - a consumer that will call methods on RouteTrafficOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • travelMode

      CalculateRoutesRequest.Builder travelMode(String travelMode)

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      Parameters:
      travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • travelMode

      CalculateRoutesRequest.Builder travelMode(RouteTravelMode travelMode)

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      Parameters:
      travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • travelModeOptions

      CalculateRoutesRequest.Builder travelModeOptions(RouteTravelModeOptions travelModeOptions)

      Travel mode related options for the provided travel mode.

      Parameters:
      travelModeOptions - Travel mode related options for the provided travel mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • travelModeOptions

      default CalculateRoutesRequest.Builder travelModeOptions(Consumer<RouteTravelModeOptions.Builder> travelModeOptions)

      Travel mode related options for the provided travel mode.

      This is a convenience method that creates an instance of the RouteTravelModeOptions.Builder avoiding the need to create one manually via RouteTravelModeOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to travelModeOptions(RouteTravelModeOptions).

      Parameters:
      travelModeOptions - a consumer that will call methods on RouteTravelModeOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • travelStepType

      CalculateRoutesRequest.Builder travelStepType(String travelStepType)

      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 navigation system.

      Parameters:
      travelStepType - 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 navigation system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • travelStepType

      CalculateRoutesRequest.Builder travelStepType(RouteTravelStepType travelStepType)

      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 navigation system.

      Parameters:
      travelStepType - 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 navigation system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • waypoints

      CalculateRoutesRequest.Builder waypoints(Collection<RouteWaypoint> waypoints)

      List of waypoints between the Origin and Destination.

      Parameters:
      waypoints - List of waypoints between the Origin and Destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • waypoints

      CalculateRoutesRequest.Builder waypoints(RouteWaypoint... waypoints)

      List of waypoints between the Origin and Destination.

      Parameters:
      waypoints - List of waypoints between the Origin and Destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • waypoints

      CalculateRoutesRequest.Builder waypoints(Consumer<RouteWaypoint.Builder>... waypoints)

      List of waypoints between the Origin and Destination.

      This is a convenience method that creates an instance of the RouteWaypoint.Builder avoiding the need to create one manually via RouteWaypoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to waypoints(List<RouteWaypoint>).

      Parameters:
      waypoints - a consumer that will call methods on RouteWaypoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CalculateRoutesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CalculateRoutesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.