Interface CalculateRouteMatrixRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>, GeoRoutesRequest.Builder, SdkBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CalculateRouteMatrixRequest

@Mutable
@NotThreadSafe
public static interface CalculateRouteMatrixRequest.Builder
extends GeoRoutesRequest.Builder, SdkPojo, CopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>

Method Summary

Modifier and Type	Method	Description
default CalculateRouteMatrixRequest.Builder	allow(Consumer<RouteMatrixAllowOptions.Builder> allow)	Features that are allowed while calculating a route.
CalculateRouteMatrixRequest.Builder	allow(RouteMatrixAllowOptions allow)	Features that are allowed while calculating a route.
default CalculateRouteMatrixRequest.Builder	avoid(Consumer<RouteMatrixAvoidanceOptions.Builder> avoid)	Features that are avoided while calculating a route.
CalculateRouteMatrixRequest.Builder	avoid(RouteMatrixAvoidanceOptions avoid)	Features that are avoided while calculating a route.
CalculateRouteMatrixRequest.Builder	departNow(Boolean departNow)	Uses the current time as the time of departure.
CalculateRouteMatrixRequest.Builder	departureTime(String departureTime)	Time of departure from thr origin.
CalculateRouteMatrixRequest.Builder	destinations(Collection<RouteMatrixDestination> destinations)	List of destinations for the route.
CalculateRouteMatrixRequest.Builder	destinations(Consumer<RouteMatrixDestination.Builder>... destinations)	List of destinations for the route.
CalculateRouteMatrixRequest.Builder	destinations(RouteMatrixDestination... destinations)	List of destinations for the route.
default CalculateRouteMatrixRequest.Builder	exclude(Consumer<RouteMatrixExclusionOptions.Builder> exclude)	Features to be strictly excluded while calculating the route.
CalculateRouteMatrixRequest.Builder	exclude(RouteMatrixExclusionOptions exclude)	Features to be strictly excluded while calculating the route.
CalculateRouteMatrixRequest.Builder	key(String key)	Optional: The API key to be used for authorization.
CalculateRouteMatrixRequest.Builder	optimizeRoutingFor(String optimizeRoutingFor)	Specifies the optimization criteria for calculating a route.
CalculateRouteMatrixRequest.Builder	optimizeRoutingFor(RoutingObjective optimizeRoutingFor)	Specifies the optimization criteria for calculating a route.
CalculateRouteMatrixRequest.Builder	origins(Collection<RouteMatrixOrigin> origins)	The position in longitude and latitude for the origin.
CalculateRouteMatrixRequest.Builder	origins(Consumer<RouteMatrixOrigin.Builder>... origins)	The position in longitude and latitude for the origin.
CalculateRouteMatrixRequest.Builder	origins(RouteMatrixOrigin... origins)	The position in longitude and latitude for the origin.
CalculateRouteMatrixRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CalculateRouteMatrixRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CalculateRouteMatrixRequest.Builder	routingBoundary(Consumer<RouteMatrixBoundary.Builder> routingBoundary)	Boundary within which the matrix is to be calculated.
CalculateRouteMatrixRequest.Builder	routingBoundary(RouteMatrixBoundary routingBoundary)	Boundary within which the matrix is to be calculated.
default CalculateRouteMatrixRequest.Builder	traffic(Consumer<RouteMatrixTrafficOptions.Builder> traffic)	Traffic related options.
CalculateRouteMatrixRequest.Builder	traffic(RouteMatrixTrafficOptions traffic)	Traffic related options.
CalculateRouteMatrixRequest.Builder	travelMode(String travelMode)	Specifies the mode of transport when calculating a route.
CalculateRouteMatrixRequest.Builder	travelMode(RouteMatrixTravelMode travelMode)	Specifies the mode of transport when calculating a route.
default CalculateRouteMatrixRequest.Builder	travelModeOptions(Consumer<RouteMatrixTravelModeOptions.Builder> travelModeOptions)	Travel mode related options for the provided travel mode.
CalculateRouteMatrixRequest.Builder	travelModeOptions(RouteMatrixTravelModeOptions travelModeOptions)	Travel mode related options for the provided travel mode.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

allow

CalculateRouteMatrixRequest.Builder allow(RouteMatrixAllowOptions 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 CalculateRouteMatrixRequest.Builder allow(Consumer<RouteMatrixAllowOptions.Builder> allow)

Features that are allowed while calculating a route.

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

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

Parameters:

allow - a consumer that will call methods on RouteMatrixAllowOptions.Builder

Returns:

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

See Also:

• allow(RouteMatrixAllowOptions)

avoid

CalculateRouteMatrixRequest.Builder avoid(RouteMatrixAvoidanceOptions 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 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.

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

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

Parameters:

avoid - a consumer that will call methods on RouteMatrixAvoidanceOptions.Builder

Returns:

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

See Also:

• avoid(RouteMatrixAvoidanceOptions)

departNow

CalculateRouteMatrixRequest.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

CalculateRouteMatrixRequest.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.

destinations

CalculateRouteMatrixRequest.Builder destinations(Collection<RouteMatrixDestination> 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. See Amazon Location's pricing page for more information.

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. See Amazon Location's pricing page for more information.

Returns:

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

destinations

CalculateRouteMatrixRequest.Builder destinations(RouteMatrixDestination... 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. See Amazon Location's pricing page for more information.

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. See Amazon Location's pricing page for more information.

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. See Amazon Location's pricing page for more information.

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

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

Parameters:

destinations - a consumer that will call methods on RouteMatrixDestination.Builder

Returns:

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

See Also:

• destinations(java.util.Collection<RouteMatrixDestination>)

exclude

CalculateRouteMatrixRequest.Builder exclude(RouteMatrixExclusionOptions 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 CalculateRouteMatrixRequest.Builder exclude(Consumer<RouteMatrixExclusionOptions.Builder> exclude)

Features to be strictly excluded while calculating the route.

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

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

Parameters:

exclude - a consumer that will call methods on RouteMatrixExclusionOptions.Builder

Returns:

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

See Also:

• exclude(RouteMatrixExclusionOptions)

key

CalculateRouteMatrixRequest.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.

optimizeRoutingFor

CalculateRouteMatrixRequest.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:

• RoutingObjective
• RoutingObjective

optimizeRoutingFor

CalculateRouteMatrixRequest.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:

• RoutingObjective
• RoutingObjective

origins

CalculateRouteMatrixRequest.Builder origins(Collection<RouteMatrixOrigin> origins)

The position in longitude and latitude for the origin.

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. See Amazon Location's pricing page for more information.

Parameters:

origins - The position in longitude and latitude for the origin.

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. See Amazon Location's pricing page for more information.

Returns:

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

origins

CalculateRouteMatrixRequest.Builder origins(RouteMatrixOrigin... origins)

The position in longitude and latitude for the origin.

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. See Amazon Location's pricing page for more information.

Parameters:

origins - The position in longitude and latitude for the origin.

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. See Amazon Location's pricing page for more information.

Returns:

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

origins

CalculateRouteMatrixRequest.Builder origins(Consumer<RouteMatrixOrigin.Builder>... origins)

The position in longitude and latitude for the origin.

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. See Amazon Location's pricing page for more information.

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

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

Parameters:

origins - a consumer that will call methods on RouteMatrixOrigin.Builder

Returns:

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

See Also:

• origins(java.util.Collection<RouteMatrixOrigin>)

routingBoundary

CalculateRouteMatrixRequest.Builder routingBoundary(RouteMatrixBoundary routingBoundary)

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When 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.

When 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.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

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

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

Parameters:

routingBoundary - a consumer that will call methods on RouteMatrixBoundary.Builder

Returns:

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

See Also:

• routingBoundary(RouteMatrixBoundary)

traffic

CalculateRouteMatrixRequest.Builder traffic(RouteMatrixTrafficOptions 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 CalculateRouteMatrixRequest.Builder traffic(Consumer<RouteMatrixTrafficOptions.Builder> traffic)

Traffic related options.

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

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

Parameters:

traffic - a consumer that will call methods on RouteMatrixTrafficOptions.Builder

Returns:

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

See Also:

• traffic(RouteMatrixTrafficOptions)

travelMode

CalculateRouteMatrixRequest.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:

• RouteMatrixTravelMode
• RouteMatrixTravelMode

travelMode

CalculateRouteMatrixRequest.Builder travelMode(RouteMatrixTravelMode 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:

• RouteMatrixTravelMode
• RouteMatrixTravelMode

travelModeOptions

CalculateRouteMatrixRequest.Builder travelModeOptions(RouteMatrixTravelModeOptions 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 CalculateRouteMatrixRequest.Builder travelModeOptions(Consumer<RouteMatrixTravelModeOptions.Builder> travelModeOptions)

Travel mode related options for the provided travel mode.

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

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

Parameters:

travelModeOptions - a consumer that will call methods on RouteMatrixTravelModeOptions.Builder

Returns:

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

See Also:

• travelModeOptions(RouteMatrixTravelModeOptions)

overrideConfiguration

CalculateRouteMatrixRequest.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

CalculateRouteMatrixRequest.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.