Package com.azure.maps.route.models

Class MapsSearchRoute

java.lang.Object

com.azure.maps.route.models.MapsSearchRoute

All Implemented Interfaces:

com.azure.json.JsonSerializable<MapsSearchRoute>

public final class MapsSearchRoute
extends Object
implements com.azure.json.JsonSerializable<MapsSearchRoute>

The Route model.

Constructor Summary

Constructors

Constructor	Description
MapsSearchRoute()	Creates an instance of Route class.

Method Summary

Modifier and Type	Method	Description
static MapsSearchRoute	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of Route from the JsonReader.
RouteGuidance	getGuidance()	Get the guidance property: Contains guidance related elements.
List<RouteLeg>	getLegs()	Get the legs property: Legs array.
List<RouteSection>	getSections()	Get the sections property: Sections array.
RouteSummary	getSummary()	Get the summary property: Summary object.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

MapsSearchRoute

public MapsSearchRoute()

Creates an instance of Route class.

Method Details

getSummary

public RouteSummary getSummary()

Get the summary property: Summary object.

Returns:

the summary value.

getLegs

public List<RouteLeg> getLegs()

Get the legs property: Legs array.

Returns:

the legs value.

getSections

public List<RouteSection> getSections()

Get the sections property: Sections array.

Returns:

the sections value.

getGuidance

public RouteGuidance getGuidance()

Get the guidance property: Contains guidance related elements. This field is present only when guidance was requested and is available.

Returns:

the guidance value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<MapsSearchRoute>

Throws:

IOException

fromJson

public static MapsSearchRoute fromJson(com.azure.json.JsonReader jsonReader)
                                throws IOException

Reads an instance of Route from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Route if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException - If an error occurs while reading the Route.