com.mapbox.api.directions.v5.models

Class NotificationDetails.Builder

java.lang.Object

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

Enclosing class:

NotificationDetails

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract NotificationDetails.Builder	actualValue(java.lang.String actualValue) If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the actual value associated with the property of the road (as opposed to NotificationDetails.requestedValue()).
abstract NotificationDetails	build() Build a new NotificationDetails object.
abstract NotificationDetails.Builder	message(java.lang.String message) If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the message of the notification.
abstract NotificationDetails.Builder	requestedValue(java.lang.String requestedValue) If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the requested value which was violated.
abstract NotificationDetails.Builder	unit(java.lang.String unit) If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is unit of measure associated with NotificationDetails.requestedValue() and NotificationDetails.actualValue().
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

requestedValue

@SerializedName(value="requested_value")
 @NonNull
public abstract NotificationDetails.Builder requestedValue(@Nullable
                                                                                                              java.lang.String requestedValue)

If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the requested value which was violated.

Parameters:

requestedValue - requested value

Returns:

this builder for chaining options together

actualValue

@SerializedName(value="actual_value")
 @NonNull
public abstract NotificationDetails.Builder actualValue(@Nullable
                                                                                                        java.lang.String actualValue)

If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the actual value associated with the property of the road (as opposed to NotificationDetails.requestedValue()).

Parameters:

actualValue - actual value

Returns:

this builder for chaining options together

unit

@NonNull
public abstract NotificationDetails.Builder unit(@Nullable
                                                          java.lang.String unit)

If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is unit of measure associated with NotificationDetails.requestedValue() and NotificationDetails.actualValue().

Parameters:

unit - unit

Returns:

this builder for chaining options together

message

@NonNull
public abstract NotificationDetails.Builder message(@Nullable
                                                             java.lang.String message)

If Notification.type() is DirectionsCriteria.NOTIFICATION_TYPE_VIOLATION and Notification.subtype() is one of: DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, it is the message of the notification.

Parameters:

message - message

Returns:

this builder for chaining options together

build

@NonNull
public abstract NotificationDetails build()

Build a new NotificationDetails object.

Returns:

a new NotificationDetails 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