com.mapbox.services.api.optimizedtrips.v1

Class MapboxOptimizedTrips

java.lang.Object

com.mapbox.services.api.MapboxService<OptimizedTripsResponse>

com.mapbox.services.api.optimizedtrips.v1.MapboxOptimizedTrips

public class MapboxOptimizedTrips
extends MapboxService<OptimizedTripsResponse>

The Mapbox Optimized Trips API returns a duration-optimized trip between the input coordinates. This is also known as solving the Traveling Salesperson Problem. A typical use case for this API is planning the route for deliveries in a city. Optimized trips can be retrieved for car driving, bicycling and walking or hiking.

Under normal plans, a maximum of 12 coordinates can be passed in at once at a maximum 60 requests per minute. For higher volumes, reach out through our contact page.

Note that for under 10 coordinates, the returned results will be optimal. For 10 and more coordinates, the results will be optimized approximations.

Since:

2.1.0

See Also:

Traveling Salesperson Problem, API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxOptimizedTrips.Builder<T extends MapboxOptimizedTrips.Builder> Optimized Trips v1 builder

Field Summary

Fields

Modifier and Type	Field and Description
protected MapboxOptimizedTrips.Builder	builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxOptimizedTrips(MapboxOptimizedTrips.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	cancelCall() Cancel the call
retrofit2.Call<OptimizedTripsResponse>	cloneCall() clone the call
void	enqueueCall(retrofit2.Callback<OptimizedTripsResponse> callback) Execute the call
retrofit2.Response<OptimizedTripsResponse>	executeCall() Execute the call

Methods inherited from class com.mapbox.services.api.MapboxService

getCallFactory, getHeaderUserAgent, getOkHttpClient, isEnableDebug, setCallFactory, setEnableDebug

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

builder

protected MapboxOptimizedTrips.Builder builder

Constructor Detail

MapboxOptimizedTrips

protected MapboxOptimizedTrips(MapboxOptimizedTrips.Builder builder)

Method Detail

executeCall

public retrofit2.Response<OptimizedTripsResponse> executeCall()
                                                       throws java.io.IOException

Execute the call

Specified by:

executeCall in class MapboxService<OptimizedTripsResponse>

Returns:

The Directions Matrix v1 response

Throws:

java.io.IOException - Signals that an I/O exception of some sort has occurred.

Since:

2.1.0

enqueueCall

public void enqueueCall(retrofit2.Callback<OptimizedTripsResponse> callback)

Execute the call

Specified by:

enqueueCall in class MapboxService<OptimizedTripsResponse>

Parameters:

callback - A Retrofit callback.

Since:

2.1.0

cancelCall

public void cancelCall()

Cancel the call

Specified by:

cancelCall in class MapboxService<OptimizedTripsResponse>

Since:

2.1.0

cloneCall

public retrofit2.Call<OptimizedTripsResponse> cloneCall()

clone the call

Specified by:

cloneCall in class MapboxService<OptimizedTripsResponse>

Returns:

cloned call

Since:

2.1.0