com.mapbox.api.optimization.v1

Class MapboxOptimization

java.lang.Object

com.mapbox.core.MapboxService<OptimizationResponse,OptimizationService>

com.mapbox.api.optimization.v1.MapboxOptimization

public abstract class MapboxOptimization
extends com.mapbox.core.MapboxService<OptimizationResponse,OptimizationService>

The Mapbox Optimization 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	MapboxOptimization.Builder Optimization v1 builder.

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxOptimization()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxOptimization.Builder	builder() Build a new MapboxOptimization object with the initial values set for baseUrl(), profile(), user(), and geometries().
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<OptimizationResponse>	initializeCall()

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, enqueueCall, executeCall, getCall, getCallFactory, getOkHttpClient, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MapboxOptimization

protected MapboxOptimization()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<OptimizationResponse,OptimizationService>

initializeCall

protected retrofit2.Call<OptimizationResponse> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<OptimizationResponse,OptimizationService>

baseUrl

@NonNull
protected abstract java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<OptimizationResponse,OptimizationService>

builder

public static MapboxOptimization.Builder builder()

Build a new MapboxOptimization object with the initial values set for baseUrl(), profile(), user(), and geometries().

Returns:

a MapboxOptimization.Builder object for creating this object

Since:

3.0.0