com.mapbox.api.directions.v5.models

Class Notification.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.Notification.Builder

Enclosing class:

Notification

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

This builder can be used to set the values describing the Notification.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract Notification	build() Build a new Notification object.
abstract Notification.Builder	chargingStationId(java.lang.String id) Notification charging station id.
abstract Notification.Builder	details(NotificationDetails details) Notification details.
abstract Notification.Builder	geometryIndex(java.lang.Integer geometryIndex) Leg-wise position in the coordinate list where the notification occurred, relative to the start of the leg it's on.
abstract Notification.Builder	geometryIndexEnd(java.lang.Integer geometryIndexEnd) Leg-wise end index of the area that violates the request parameter.
abstract Notification.Builder	geometryIndexStart(java.lang.Integer geometryIndexStart) Leg-wise start index of the area that violates the request parameter.
abstract Notification.Builder	reason(java.lang.String reason) Notification reason.
abstract Notification.Builder	refreshType(java.lang.String type) Notification refresh type.
abstract Notification.Builder	subtype(java.lang.String subtype) Notification subtype.
abstract Notification.Builder	type(java.lang.String type) Notification type.
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the 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

type

@NonNull
public abstract Notification.Builder type(@NonNull
                                                   java.lang.String type)

Notification type. Can be one of DirectionsCriteria.NotificationsTypeCriteria.

Parameters:

type - notification type

Returns:

this builder for chaining options together

refreshType

@SerializedName(value="refresh_type")
 @NonNull
public abstract Notification.Builder refreshType(@NonNull
                                                                                                 java.lang.String type)

Notification refresh type. Can be one of DirectionsCriteria.NotificationsRefreshTypeCriteria.

Parameters:

type - notification refresh type

Returns:

this builder for chaining options together

subtype

@NonNull
public abstract Notification.Builder subtype(@Nullable
                                                      java.lang.String subtype)

Notification subtype. Can be one of DirectionsCriteria.NotificationsSubtypeCriteria, depending on Notification.type().

Parameters:

subtype - notification subtype

Returns:

this builder for chaining options together

geometryIndexStart

@SerializedName(value="geometry_index_start")
 @NonNull
public abstract Notification.Builder geometryIndexStart(@Nullable
                                                                                                                java.lang.Integer geometryIndexStart)

Leg-wise start index of the area that violates the request parameter.

Parameters:

geometryIndexStart - start index

Returns:

this builder for chaining options together

geometryIndex

@SerializedName(value="geometry_index")
 @NonNull
public abstract Notification.Builder geometryIndex(@Nullable
                                                                                                     java.lang.Integer geometryIndex)

Leg-wise position in the coordinate list where the notification occurred, relative to the start of the leg it's on.

Parameters:

geometryIndex - index

Returns:

this builder for chaining options together

geometryIndexEnd

@SerializedName(value="geometry_index_end")
 @NonNull
public abstract Notification.Builder geometryIndexEnd(@Nullable
                                                                                                            java.lang.Integer geometryIndexEnd)

Leg-wise end index of the area that violates the request parameter.

Parameters:

geometryIndexEnd - end index

Returns:

this builder for chaining options together

details

@NonNull
public abstract Notification.Builder details(@Nullable
                                                      NotificationDetails details)

Notification details.

Parameters:

details - notification details

Returns:

this builder for chaining options together

reason

@NonNull
public abstract Notification.Builder reason(@Nullable
                                                     java.lang.String reason)

Notification reason. It is valid only if Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_ALERT and Notification.subtype() is DirectionsCriteria.NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE.

Parameters:

reason - for the unavailability of the charging station for the electric vehicle. Can be one of DirectionsCriteria.NotificationsEvStationUnavailableReasonCriteria.

Returns:

this builder for chaining options together

chargingStationId

@SerializedName(value="station_id")
 @NonNull
public abstract Notification.Builder chargingStationId(@Nullable
                                                                                                     java.lang.String id)

Notification charging station id. It is valid only if Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_ALERT and Notification.subtype() is DirectionsCriteria.NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE.

Parameters:

id - of the unavailable charging station for the electric vehicle

Returns:

this builder for chaining options together

build

@NonNull
public abstract Notification build()

Build a new Notification object.

Returns:

a new Notification using the provided values in this builder

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request