Interface CalculateRouteMatrixRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CalculateRouteMatrixRequest.Builder,,CalculateRouteMatrixRequest> GeoRoutesRequest.Builder,SdkBuilder<CalculateRouteMatrixRequest.Builder,,CalculateRouteMatrixRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CalculateRouteMatrixRequest
-
Method Summary
Modifier and TypeMethodDescriptionFeatures that are allowed while calculating a route.allow(RouteMatrixAllowOptions allow) Features that are allowed while calculating a route.Features that are avoided while calculating a route.avoid(RouteMatrixAvoidanceOptions avoid) Features that are avoided while calculating a route.Uses the current time as the time of departure.departureTime(String departureTime) Time of departure from the origin.destinations(Collection<RouteMatrixDestination> destinations) List of destinations for the route.destinations(Consumer<RouteMatrixDestination.Builder>... destinations) List of destinations for the route.destinations(RouteMatrixDestination... destinations) List of destinations for the route.Features to be strictly excluded while calculating the route.exclude(RouteMatrixExclusionOptions exclude) Features to be strictly excluded while calculating the route.Optional: The API key to be used for authorization.optimizeRoutingFor(String optimizeRoutingFor) Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.optimizeRoutingFor(RoutingObjective optimizeRoutingFor) Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.origins(Collection<RouteMatrixOrigin> origins) The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].origins(Consumer<RouteMatrixOrigin.Builder>... origins) The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].origins(RouteMatrixOrigin... origins) The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.routingBoundary(Consumer<RouteMatrixBoundary.Builder> routingBoundary) Boundary within which the matrix is to be calculated.routingBoundary(RouteMatrixBoundary routingBoundary) Boundary within which the matrix is to be calculated.traffic(Consumer<RouteMatrixTrafficOptions.Builder> traffic) Traffic related options.traffic(RouteMatrixTrafficOptions traffic) Traffic related options.travelMode(String travelMode) Specifies the mode of transport when calculating a route.travelMode(RouteMatrixTravelMode travelMode) Specifies the mode of transport when calculating a route.travelModeOptions(Consumer<RouteMatrixTravelModeOptions.Builder> travelModeOptions) Travel mode related options for the provided travel mode.travelModeOptions(RouteMatrixTravelModeOptions travelModeOptions) Travel mode related options for the provided travel mode.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
Features that are allowed while calculating a route.
This is a convenience method that creates an instance of theRouteMatrixAllowOptions.Builderavoiding the need to create one manually viaRouteMatrixAllowOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toallow(RouteMatrixAllowOptions).- Parameters:
allow- a consumer that will call methods onRouteMatrixAllowOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. For GrabMaps customers,
ap-southeast-1andap-southeast-5regions support onlyTollRoads,Ferries, andControlledAccessHighways.- 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. For GrabMaps customers,ap-southeast-1andap-southeast-5regions support onlyTollRoads,Ferries, andControlledAccessHighways.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
avoid
default CalculateRouteMatrixRequest.Builder avoid(Consumer<RouteMatrixAvoidanceOptions.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. For GrabMaps customers,
This is a convenience method that creates an instance of theap-southeast-1andap-southeast-5regions support onlyTollRoads,Ferries, andControlledAccessHighways.RouteMatrixAvoidanceOptions.Builderavoiding the need to create one manually viaRouteMatrixAvoidanceOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toavoid(RouteMatrixAvoidanceOptions).- Parameters:
avoid- a consumer that will call methods onRouteMatrixAvoidanceOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Time of departure from the origin.
Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Parameters:
departureTime- Time of departure from the origin.Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinations
List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Parameters:
destinations- List of destinations for the route.Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinations
List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Parameters:
destinations- List of destinations for the route.Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinations
CalculateRouteMatrixRequest.Builder destinations(Consumer<RouteMatrixDestination.Builder>... destinations) List of destinations for the route.
Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
RouteMatrixDestination.Builderavoiding the need to create one manually viaRouteMatrixDestination.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todestinations(List<RouteMatrixDestination>).- Parameters:
destinations- a consumer that will call methods onRouteMatrixDestination.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
exclude
Features to be strictly excluded while calculating the route. Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.- Parameters:
exclude- Features to be strictly excluded while calculating the route. Not supported inap-southeast-1andap-southeast-5regions for GrabMaps customers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclude
default CalculateRouteMatrixRequest.Builder exclude(Consumer<RouteMatrixExclusionOptions.Builder> exclude) Features to be strictly excluded while calculating the route. Not supported in
This is a convenience method that creates an instance of theap-southeast-1andap-southeast-5regions for GrabMaps customers.RouteMatrixExclusionOptions.Builderavoiding the need to create one manually viaRouteMatrixExclusionOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toexclude(RouteMatrixExclusionOptions).- Parameters:
exclude- a consumer that will call methods onRouteMatrixExclusionOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
optimizeRoutingFor
Controls the trade-off between finding the shortest travel time (
FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.Default value:
FastestRoute- Parameters:
optimizeRoutingFor- Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.Default value:
FastestRoute- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
optimizeRoutingFor
Controls the trade-off between finding the shortest travel time (
FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.Default value:
FastestRoute- Parameters:
optimizeRoutingFor- Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.Default value:
FastestRoute- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
origins
The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Parameters:
origins- The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origins
The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Parameters:
origins- The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origins
The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].
Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
RouteMatrixOrigin.Builderavoiding the need to create one manually viaRouteMatrixOrigin.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toorigins(List<RouteMatrixOrigin>).- Parameters:
origins- a consumer that will call methods onRouteMatrixOrigin.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
routingBoundary
Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers,
ap-southeast-1andap-southeast-5regions support onlyUnboundedset totrue.Default value:
Unbounded set to trueWhen request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
- Parameters:
routingBoundary- Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers,ap-southeast-1andap-southeast-5regions support onlyUnboundedset totrue.Default value:
Unbounded set to trueWhen request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routingBoundary
default CalculateRouteMatrixRequest.Builder routingBoundary(Consumer<RouteMatrixBoundary.Builder> routingBoundary) Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers,
ap-southeast-1andap-southeast-5regions support onlyUnboundedset totrue.Default value:
Unbounded set to trueWhen request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
RouteMatrixBoundary.Builderavoiding the need to create one manually viaRouteMatrixBoundary.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toroutingBoundary(RouteMatrixBoundary).- Parameters:
routingBoundary- a consumer that will call methods onRouteMatrixBoundary.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
traffic
Traffic related options. Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.- Parameters:
traffic- Traffic related options. Not supported inap-southeast-1andap-southeast-5regions for GrabMaps customers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
traffic
default CalculateRouteMatrixRequest.Builder traffic(Consumer<RouteMatrixTrafficOptions.Builder> traffic) Traffic related options. Not supported in
This is a convenience method that creates an instance of theap-southeast-1andap-southeast-5regions for GrabMaps customers.RouteMatrixTrafficOptions.Builderavoiding the need to create one manually viaRouteMatrixTrafficOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totraffic(RouteMatrixTrafficOptions).- Parameters:
traffic- a consumer that will call methods onRouteMatrixTrafficOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelMode
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers,
ap-southeast-1andap-southeast-5regions support onlyCar,Pedestrian, andScooter.Default value:
Car- Parameters:
travelMode- Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers,ap-southeast-1andap-southeast-5regions support onlyCar,Pedestrian, andScooter.Default value:
Car- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelMode
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers,
ap-southeast-1andap-southeast-5regions support onlyCar,Pedestrian, andScooter.Default value:
Car- Parameters:
travelMode- Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers,ap-southeast-1andap-southeast-5regions support onlyCar,Pedestrian, andScooter.Default value:
Car- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelModeOptions
CalculateRouteMatrixRequest.Builder travelModeOptions(RouteMatrixTravelModeOptions travelModeOptions) Travel mode related options for the provided travel mode. Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.- Parameters:
travelModeOptions- Travel mode related options for the provided travel mode. Not supported inap-southeast-1andap-southeast-5regions for GrabMaps customers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
travelModeOptions
default CalculateRouteMatrixRequest.Builder travelModeOptions(Consumer<RouteMatrixTravelModeOptions.Builder> travelModeOptions) Travel mode related options for the provided travel mode. Not supported in
This is a convenience method that creates an instance of theap-southeast-1andap-southeast-5regions for GrabMaps customers.RouteMatrixTravelModeOptions.Builderavoiding the need to create one manually viaRouteMatrixTravelModeOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totravelModeOptions(RouteMatrixTravelModeOptions).- Parameters:
travelModeOptions- a consumer that will call methods onRouteMatrixTravelModeOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CalculateRouteMatrixRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CalculateRouteMatrixRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-