com.mapbox.api.optimization.v1.models

Class OptimizationResponse

java.lang.Object

com.mapbox.api.optimization.v1.models.OptimizationResponse

All Implemented Interfaces:

java.io.Serializable

public abstract class OptimizationResponse
extends java.lang.Object
implements java.io.Serializable

When the Mapbox Optimization API response, this will be the root class for accessing all the response information provided.

Since:

2.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptimizationResponse.Builder This builder can be used to set the values describing the OptimizationResponse.

Constructor Summary

Constructors

Constructor and Description
OptimizationResponse()

Method Summary

Modifier and Type	Method and Description
static OptimizationResponse.Builder	builder() Create a new instance of this class by using the OptimizationResponse.Builder class.
abstract java.lang.String	code() String indicating the state of the response.
abstract OptimizationResponse.Builder	toBuilder() Convert the current OptimizationResponse to its builder holding the currently assigned values.
abstract java.util.List<com.mapbox.api.directions.v5.models.DirectionsRoute>	trips() List of trip DirectionsRoute objects.
static com.google.gson.TypeAdapter<OptimizationResponse>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.util.List<OptimizationWaypoint>	waypoints() List of OptimizationWaypoint objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizationResponse

public OptimizationResponse()

Method Detail

builder

@NonNull
public static OptimizationResponse.Builder builder()

Create a new instance of this class by using the OptimizationResponse.Builder class.

Returns:

this classes OptimizationResponse.Builder for creating a new instance

Since:

3.0.0

code

@Nullable
public abstract java.lang.String code()

String indicating the state of the response. This is a separate code than the HTTP status code. On normal valid responses, the value will be Ok.

On error, the server responds with different HTTP status codes. For responses with HTTP status codes lower than 500, the JSON response body includes the code property, which may be used by client programs to manage control flow. The response body may also include a message property, with a human-readable explanation of the error. If a server error occurs, the HTTP status code will be 500 or higher and the response will not include a code property. Possible errors include:

• Ok: 200 Normal success case
• NoTrips: 200 For one coordinate no route to other coordinates could be found. Check for impossible routes (e.g. routes over oceans without ferry connections).
• NotImplemented: 200 For the given combination of source, destination and roundtrip, this request is not supported.
• ProfileNotFound: 404 Use a valid profile
• InvalidInput: 422 The given request was not valid. The message key of the response will hold an explanation of the invalid input.

Returns:

string containing the response code. In normal conditions this will return OK

Since:

2.1.0

waypoints

@Nullable
public abstract java.util.List<OptimizationWaypoint> waypoints()

List of OptimizationWaypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoints appear in the list in the order of the input coordinates.

Returns:

a list of OptimizationWaypoints in the order of the input coordinates

Since:

2.1.0

trips

@Nullable
public abstract java.util.List<com.mapbox.api.directions.v5.models.DirectionsRoute> trips()

List of trip DirectionsRoute objects. Will have zero or one trip.

Returns:

list of DirectionsRoute either having a size zero or one

Since:

2.1.0

toBuilder

public abstract OptimizationResponse.Builder toBuilder()

Convert the current OptimizationResponse to its builder holding the currently assigned values. This allows you to modify a single variable and then rebuild the object resulting in an updated and modified OptimizationResponse.

Returns:

a OptimizationResponse.Builder with the same values set to match the ones defined in this OptimizationResponse

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<OptimizationResponse> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

Since:

3.0.0