com.mapbox.api.directionsrefresh.v1

Class MapboxDirectionsRefresh.Builder

java.lang.Object

com.mapbox.api.directionsrefresh.v1.MapboxDirectionsRefresh.Builder

Enclosing class:

MapboxDirectionsRefresh

public abstract static class MapboxDirectionsRefresh.Builder
extends java.lang.Object

This builder is used to build a new request to the Mapbox Directions Refresh API. A request requires an access token and a request id.

Since:

4.4.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapboxDirectionsRefresh.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract MapboxDirectionsRefresh.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Mapbox one.
abstract MapboxDirectionsRefresh	build() Returns an instance of MapboxDirectionsRefresh for interacting with the endpoint with the specified values.
abstract MapboxDirectionsRefresh.Builder	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.
abstract MapboxDirectionsRefresh.Builder	interceptor(okhttp3.Interceptor interceptor) Adds an optional interceptor to set in the OkHttp client.
abstract MapboxDirectionsRefresh.Builder	legIndex(int legIndex) Index of leg of which to start.
abstract MapboxDirectionsRefresh.Builder	requestId(java.lang.String requestId) Specified here is the uuid of the initial directions request.
abstract MapboxDirectionsRefresh.Builder	routeIndex(int routeIndex) Index of original route in response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

requestId

public abstract MapboxDirectionsRefresh.Builder requestId(java.lang.String requestId)

Specified here is the uuid of the initial directions request. The original request must have specified enableRefresh.

Parameters:

requestId - id of the original directions request. This is found in the RouteOptions object.

Returns:

this builder

Since:

4.4.0

routeIndex

public abstract MapboxDirectionsRefresh.Builder routeIndex(@NonNull
                                                           int routeIndex)

Index of original route in response.

Parameters:

routeIndex - index of route in response

Returns:

this builder

Since:

4.4.0

legIndex

public abstract MapboxDirectionsRefresh.Builder legIndex(@NonNull
                                                         int legIndex)

Index of leg of which to start. The response will include the annotations of the specified leg through the end of the list of legs.

Parameters:

legIndex - index of leg

Returns:

this builder

Since:

4.4.0

accessToken

public abstract MapboxDirectionsRefresh.Builder accessToken(@NonNull
                                                            java.lang.String accessToken)

Required to call when this is being built. If no access token provided, ServicesException will be thrown.

Parameters:

accessToken - Mapbox access token

Returns:

this builder

Since:

4.4.0

clientAppName

public abstract MapboxDirectionsRefresh.Builder clientAppName(@NonNull
                                                              java.lang.String clientAppName)

Base package name or other simple string identifier. Used inside the calls user agent header.

Parameters:

clientAppName - base package name or other simple string identifier

Returns:

this builder for chaining options together

Since:

4.4.0

baseUrl

public abstract MapboxDirectionsRefresh.Builder baseUrl(java.lang.String baseUrl)

Optionally change the APIs base URL to something other then the default Mapbox one.

Parameters:

baseUrl - base url used as endpoint

Returns:

this builder

Since:

4.4.0

interceptor

public abstract MapboxDirectionsRefresh.Builder interceptor(okhttp3.Interceptor interceptor)

Adds an optional interceptor to set in the OkHttp client.

Parameters:

interceptor - to set for OkHttp

Returns:

this builder for chaining options together

Since:

4.9.0

build

public abstract MapboxDirectionsRefresh build()

Returns an instance of MapboxDirectionsRefresh for interacting with the endpoint with the specified values.

Returns:

instance of MapboxDirectionsRefresh with specified attributes

Since:

4.4.0