Index
All Classes and Interfaces|All Packages
A
- Adding the package to your product - Search tag in Overview
- Section
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Adds a custom Http pipeline policy.
- ALL - Static variable in class com.azure.maps.route.models.ComputeTravelTime
-
Computes travel times for all types of traffic information and specifies all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response.
- ALREADY_USED_ROADS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids using the same road multiple times.
- AlternativeRouteType - Class in com.azure.maps.route.models
-
Defines values for AlternativeRouteType.
- AlternativeRouteType() - Constructor for class com.azure.maps.route.models.AlternativeRouteType
-
Deprecated.
- ANY_ROUTE - Static variable in class com.azure.maps.route.models.AlternativeRouteType
-
Allow any alternative route to be returned irrespective of how it compares to the reference route in terms of optimality.
- ARRIVE - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have arrived.
- ARRIVE_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have arrived.
- ARRIVE_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have arrived.
- Authentication - Search tag in Overview
- Section
- Azure Maps SDK Route client library for Java - Search tag in Overview
- Section
B
- BaseRouteOptions<T> - Class in com.azure.maps.route.models
-
Base Route Options
- BaseRouteOptions() - Constructor for class com.azure.maps.route.models.BaseRouteOptions
-
Creates a new instance of
BaseRouteOptions. - BatchResultItem - Class in com.azure.maps.route.models
-
An item returned from Batch API.
- BatchResultItem() - Constructor for class com.azure.maps.route.models.BatchResultItem
-
Creates an instance of BatchResultItem class.
- BatchResultSummary - Class in com.azure.maps.route.models
-
Summary of the results for the batch request.
- BatchResultSummary() - Constructor for class com.azure.maps.route.models.BatchResultSummary
-
Creates an instance of BatchResultSummary class.
- BEAR_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Bear left.
- BEAR_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Bear right.
- beginGetRouteDirectionsBatch(String) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions Batch Id
- beginGetRouteDirectionsBatch(String) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions Batch Id
- beginGetRouteDirectionsBatch(String, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions Batch Id
- beginGetRouteMatrix(RouteMatrixOptions) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Request Route Matrix
- beginGetRouteMatrix(RouteMatrixOptions) - Method in class com.azure.maps.route.MapsRouteClient
-
Request Route Matrix
- beginGetRouteMatrix(RouteMatrixOptions, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Request Route Matrix
- beginGetRouteMatrix(String) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Matrix Batch
- beginGetRouteMatrix(String) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Matrix Batch
- beginGetRouteMatrix(String, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Matrix Batch
- beginRequestRouteDirectionsBatch(List<RouteDirectionsOptions>) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions Batch
- beginRequestRouteDirectionsBatch(List<RouteDirectionsOptions>) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions Batch
- beginRequestRouteDirectionsBatch(List<RouteDirectionsOptions>, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions Batch
- BETTER_ROUTE - Static variable in class com.azure.maps.route.models.AlternativeRouteType
-
Return an alternative route only if it is better than the reference route according to the given planning criteria.
- BICYCLE - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for bicycles, including use of bicycle lanes.
- BICYCLE - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for bicycles, including use of bicycle lanes.
- BIFURCATION - Static variable in class com.azure.maps.route.models.JunctionType
-
bifurcation.
- BORDER_CROSSINGS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids border crossings in route calculation.
- buildAsyncClient() - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Builds an instance of SearchAsyncClient async client.
- buildClient() - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Builds an instance of SearchClient sync client.
- BUS - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for buses, including the use of bus only lanes.
- BUS - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for buses, including the use of bus only lanes.
C
- CAR - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for cars.
- CAR - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for cars.
- CAR_OR_TRAIN - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are cars or trains.
- CAR_OR_TRAIN - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are cars or trains.
- CARPOOL - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes.
- CARPOOL - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes.
- CARPOOLS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids routes that require the use of carpool (HOV/High Occupancy Vehicle) lanes.
- clientOptions(ClientOptions) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The client options such as application ID and custom headers to set on a request.
- CODED - Static variable in class com.azure.maps.route.models.RouteInstructionsType
-
Returns raw instruction data without human-readable messages.
- com.azure.maps.route - package com.azure.maps.route
-
Package containing the classes for RouteClient.
- com.azure.maps.route.models - package com.azure.maps.route.models
-
Package containing the data models for RouteClient.
- COMBUSTION - Static variable in class com.azure.maps.route.models.VehicleEngineType
-
Internal combustion engine.
- ComputeTravelTime - Class in com.azure.maps.route.models
-
Defines values for ComputeTravelTime.
- ComputeTravelTime() - Constructor for class com.azure.maps.route.models.ComputeTravelTime
-
Deprecated.Use the
ComputeTravelTime.fromString(String)factory method. - configuration(Configuration) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The configuration store that is used during construction of the service client.
- Contributing - Search tag in Overview
- Section
- COUNTRY - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections indicating which countries/regions the route is in.
- COUNTRY - Static variable in class com.azure.maps.route.models.SectionType
-
Sections indicating which countries/regions the route is in.
- credential(AzureKeyCredential) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets the
AzureKeyCredentialused to authenticate HTTP requests. - credential(AzureSasCredential) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets the
AzureSasCredentialused to authenticate HTTP requests. - credential(TokenCredential) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets the
TokenCredentialused to authenticate HTTP requests.
D
- DelayMagnitude - Class in com.azure.maps.route.models
-
The magnitude of delay caused by the incident.
- DelayMagnitude() - Constructor for class com.azure.maps.route.models.DelayMagnitude
-
Deprecated.Use the
DelayMagnitude.fromString(String)factory method. - DEPART - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Leave.
- DIRECTION_INFO - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Direction information.
- Documentation - Search tag in Overview
- Section
- DrivingSide - Class in com.azure.maps.route.models
-
Indicates left-hand vs. right-hand side driving at the point of the maneuver.
- DrivingSide() - Constructor for class com.azure.maps.route.models.DrivingSide
-
Deprecated.Use the
DrivingSide.fromString(String)factory method.
E
- ECONOMY - Static variable in class com.azure.maps.route.models.RouteType
-
A route balanced by economy and speed.
- EFFECTIVE_SETTINGS - Static variable in class com.azure.maps.route.models.Report
-
Reports the effective parameters or data used when calling the API.
- EffectiveSetting - Class in com.azure.maps.route.models
-
Effective parameter or data used when calling this Route API.
- EffectiveSetting() - Constructor for class com.azure.maps.route.models.EffectiveSetting
-
Creates an instance of EffectiveSetting class.
- ELECTRIC - Static variable in class com.azure.maps.route.models.VehicleEngineType
-
Electric engine.
- endpoint(String) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Set endpoint of the service.
- ENTER_FREEWAY - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the freeway.
- ENTER_HIGHWAY - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the highway.
- ENTER_MOTORWAY - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the motorway.
- ENTRANCE_RAMP - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the ramp.
- Examples - Search tag in Overview
- Section
F
- FASTEST - Static variable in class com.azure.maps.route.models.RouteType
-
The fastest route.
- FERRIES - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids ferries.
- FERRY - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are ferries.
- FERRY - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are ferries.
- FOLLOW - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Follow.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.BatchResultItem
-
Reads an instance of BatchResultItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.BatchResultSummary
-
Reads an instance of BatchResultSummary from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.EffectiveSetting
-
Reads an instance of EffectiveSetting from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.MapsSearchRoute
-
Reads an instance of Route from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteDirections
-
Reads an instance of RouteDirections from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteDirectionsBatchItem
-
Reads an instance of RouteDirectionsBatchItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteDirectionsBatchResult
-
Reads an instance of RouteDirectionsBatchResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteGuidance
-
Reads an instance of RouteGuidance from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteInstruction
-
Reads an instance of RouteInstruction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteInstructionGroup
-
Reads an instance of RouteInstructionGroup from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteLeg
-
Reads an instance of RouteLeg from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteLegSummary
-
Reads an instance of RouteLegSummary from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteMatrix
-
Reads an instance of RouteMatrix from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteMatrixResult
-
Reads an instance of RouteMatrixResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteMatrixSummary
-
Reads an instance of RouteMatrixSummary from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteOptimizedWaypoint
-
Reads an instance of RouteOptimizedWaypoint from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteRange
-
Reads an instance of RouteRange from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteRangeResult
-
Reads an instance of RouteRangeResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteReport
-
Reads an instance of RouteReport from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteSection
-
Reads an instance of RouteSection from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteSectionTec
-
Reads an instance of RouteSectionTec from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteSectionTecCause
-
Reads an instance of RouteSectionTecCause from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.route.models.RouteSummary
-
Reads an instance of RouteSummary from the JsonReader.
- fromString(String) - Static method in class com.azure.maps.route.models.AlternativeRouteType
-
Creates or finds a AlternativeRouteType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.ComputeTravelTime
-
Creates or finds a ComputeTravelTime from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.DelayMagnitude
-
Creates or finds a DelayMagnitude from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.DrivingSide
-
Creates or finds a DrivingSide from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.GuidanceInstructionType
-
Creates or finds a GuidanceInstructionType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.GuidanceManeuver
-
Creates or finds a GuidanceManeuver from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.InclineLevel
-
Creates or finds a InclineLevel from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.JunctionType
-
Creates or finds a JunctionType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.Report
-
Creates or finds a Report from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteAvoidType
-
Creates or finds a RouteAvoidType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteDelayReason
-
Creates or finds a SimpleCategory from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteInstructionsType
-
Creates or finds a RouteInstructionsType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Creates or finds a RouteRepresentationForBestOrder from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteSectionType
-
Creates or finds a ResponseSectionType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteTravelMode
-
Creates or finds a ResponseTravelMode from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.RouteType
-
Creates or finds a RouteType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.SectionType
-
Creates or finds a SectionType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.TravelMode
-
Creates or finds a TravelMode from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.VehicleEngineType
-
Creates or finds a VehicleEngineType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.VehicleLoadType
-
Creates or finds a VehicleLoadType from its string representation.
- fromString(String) - Static method in class com.azure.maps.route.models.WindingnessLevel
-
Creates or finds a WindingnessLevel from its string representation.
G
- getAccelerationEfficiency() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the acceleration efficiency.
- getAllowVignette() - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Get the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g.
- getAlternativeType() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the type of the alternative route
- getArrivalTime() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the arrivalTime property: The estimated arrival time for the route or leg.
- getArrivalTime() - Method in class com.azure.maps.route.models.RouteSummary
-
Get the arrivalTime property: The estimated arrival time for the route or leg.
- getArriveAt() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the arrival time.
- getArriveAt() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the arrival time.
- getAuxiliaryPowerInKw() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the auxiliary power.
- getAuxiliaryPowerInLitersPerHour() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the auxiliary power in liters per hour.
- getAvoid() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the list of route types to avoid.
- getAvoidAreas() - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Get the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid.
- getAvoidRouteTypes() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the list of route types to avoid.
- getAvoidVignette() - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Get the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g.
- getBatchId() - Method in class com.azure.maps.route.models.RouteDirectionsBatchResult
-
Get the batch id of this request.
- getBatchItems() - Method in class com.azure.maps.route.models.RouteDirectionsBatchResult
-
Get the batchItems property: Array containing the batch results.
- getBatteryConsumptionInKwH() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the batteryConsumptionInKwH property: Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model.
- getBoundary() - Method in class com.azure.maps.route.models.RouteRange
-
Returns a list of
GeoPositioncoordinates. - getCauses() - Method in class com.azure.maps.route.models.RouteSectionTec
-
Get the causes property: Causes array.
- getCenter() - Method in class com.azure.maps.route.models.RouteRange
-
Returns the
GeoPositioncoordinates of the center of the range. - getCombinedMessage() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the combinedMessage property: A human-readable message for the maneuver combined with the message from the next instruction.
- getComputeBestWaypointOrder() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns whether to use the best waypoint order.
- getComputeTravelTime() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the type of computation for the travel time.
- getComputeTravelTime() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.
- getConstantSpeedConsumptionInKwHPerHundredKm() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the constant speed energy consumption.
- getConstantSpeedConsumptionInLitersPerHundredKm() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the constant speed fuel consumption.
- getCountryCode() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the countryCode property: 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code.
- getCurrentChargeInKwH() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the current charge.
- getCurrentFuelInLiters() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the current fuel in liters.
- getDecelerationEfficiency() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the deceleration efficiency.
- getDelayInSeconds() - Method in class com.azure.maps.route.models.RouteSection
-
Get the delayInSeconds property: Delay in seconds caused by the incident.
- getDelayMagnitude() - Method in class com.azure.maps.route.models.RouteSection
-
Get the delayMagnitude property: The magnitude of delay caused by the incident.
- getDepartAt() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the departure time.
- getDepartAt() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the departure time.
- getDepartureTime() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the departureTime property: The estimated departure time for the route or leg.
- getDepartureTime() - Method in class com.azure.maps.route.models.RouteSummary
-
Get the departureTime property: The estimated departure time for the route or leg.
- getDestinations() - Method in class com.azure.maps.route.models.RouteMatrixQuery
-
Get the destinations property: A valid `GeoJSON MultiPoint` geometry type.
- getDistanceBudgetInMeters() - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Returns the distance budget in meters.
- getDownhillEfficiency() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the downhill efficiency.
- getDrivingSide() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the drivingSide property: Indicates left-hand vs. right-hand side driving at the point of the maneuver.
- getEffectCode() - Method in class com.azure.maps.route.models.RouteSectionTec
-
Get the effectCode property: The effect on the traffic flow.
- getEffectiveSettings() - Method in class com.azure.maps.route.models.RouteReport
-
Get the effectiveSettings property: Effective parameters or data used when calling this Route API.
- getEffectiveSpeedInKmh() - Method in class com.azure.maps.route.models.RouteSection
-
Get the effectiveSpeedInKmh property: Effective speed of the incident in km/h, averaged over its entire length.
- getEndPointIndex() - Method in class com.azure.maps.route.models.RouteSection
-
Get the endPointIndex property: Index of the last point (offset 0) in the route this section applies to.
- getEnergyBudgetInKwH() - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Returns the energy budget in KwH.
- getError() - Method in class com.azure.maps.route.models.RouteDirectionsBatchItem
-
Returns the
ResponseErrorin case of an error response. - getExitNumber() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the exitNumber property: The number(s) of a highway exit taken by the current maneuver.
- getFilterSectionType() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the type of
SectionTypeused for filtering. - getFilterSectionType() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Specifies which of the section types is reported in the route response.
- getFirstInstructionIndex() - Method in class com.azure.maps.route.models.RouteInstructionGroup
-
Get the firstInstructionIndex property: Index of the first instruction in the instructions and belonging to this group.
- getFormatVersion() - Method in class com.azure.maps.route.models.RouteDirections
-
Get the formatVersion property: Format Version property.
- getFormatVersion() - Method in class com.azure.maps.route.models.RouteMatrixResult
-
Get the formatVersion property: Format Version property.
- getFormatVersion() - Method in class com.azure.maps.route.models.RouteRangeResult
-
Get the formatVersion property: Format Version property.
- getFuelBudgetInLiters() - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Returns the fuel budget in liters.
- getFuelConsumptionInLiters() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the fuelConsumptionInLiters property: Estimated fuel consumption in liters using the Combustion Consumption Model.
- getFuelEnergyDensityInMegajoulesPerLiter() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the fuel energy density.
- getGroupLengthInMeters() - Method in class com.azure.maps.route.models.RouteInstructionGroup
-
Get the groupLengthInMeters property: Length of the group.
- getGroupMessage() - Method in class com.azure.maps.route.models.RouteInstructionGroup
-
Get the groupMessage property: Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).
- getGuidance() - Method in class com.azure.maps.route.models.MapsSearchRoute
-
Get the guidance property: Contains guidance related elements.
- getHistoricTrafficTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the historicTrafficTravelTimeInSeconds property: Estimated travel time calculated using time-dependent historic traffic data.
- getInclineLevel() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Return the incline level.
- getInclineLevel() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the incline level
InclineLevel - getInstructionGroups() - Method in class com.azure.maps.route.models.RouteGuidance
-
Get the instructionGroups property: Groups a sequence of instruction elements which are related to each other.
- getInstructions() - Method in class com.azure.maps.route.models.RouteGuidance
-
Get the instructions property: A list of instructions describing maneuvers.
- getInstructionsType() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the type of route instructions.
- getInstructionType() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the instructionType property: Type of the instruction, e.g., turn or change of road form.
- getJunctionType() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the junctionType property: The type of the junction where the maneuver takes place.
- getKey() - Method in class com.azure.maps.route.models.EffectiveSetting
-
Get the key property: Name of the parameter used.
- getLanguage() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the language.
- getLastInstructionIndex() - Method in class com.azure.maps.route.models.RouteInstructionGroup
-
Get the lastInstructionIndex property: Index of the last instruction in the instructions and belonging to this group.
- getLatest() - Static method in enum com.azure.maps.route.MapsRouteServiceVersion
-
Gets the latest service version supported by this client library
- getLegs() - Method in class com.azure.maps.route.models.MapsSearchRoute
-
Get the legs property: Legs array.
- getLengthInMeters() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the lengthInMeters property: Length In Meters property.
- getLengthInMeters() - Method in class com.azure.maps.route.models.RouteSummary
-
Get the lengthInMeters property: Length In Meters property.
- getLiveTrafficIncidentsTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the liveTrafficIncidentsTravelTimeInSeconds property: Estimated travel time calculated using real-time speed data.
- getMainCauseCode() - Method in class com.azure.maps.route.models.RouteSectionTecCause
-
Get the mainCauseCode property: The main cause of the traffic event.
- getManeuver() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the maneuver property: A code identifying the maneuver.
- getMatrix() - Method in class com.azure.maps.route.models.RouteMatrixResult
-
Get the matrix property: Results as a 2 dimensional array of route summaries.
- getMatrixId() - Method in class com.azure.maps.route.models.RouteMatrixResult
-
Get the matrix id of this request.
- getMaxAlternatives() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the maximum number of alternative routes.
- getMaxChargeInKwH() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the max charge.
- getMessage() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the message property: A human-readable message for the maneuver.
- getMinDeviationDistance() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the minimum deviation distance.
- getMinDeviationTime() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the minimal deviation time.
- getNoTrafficTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the noTrafficTravelTimeInSeconds property: Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion).
- getOptimizedIndex() - Method in class com.azure.maps.route.models.RouteOptimizedWaypoint
-
Get the optimizedIndex property: Optimized way point index from the system.
- getOptimizedWaypoints() - Method in class com.azure.maps.route.models.RouteDirections
-
Get the optimizedWaypoints property: Optimized sequence of waypoints.
- getOrigins() - Method in class com.azure.maps.route.models.RouteMatrixQuery
-
Get the origins property: A valid `GeoJSON MultiPoint` geometry type.
- getPoint() - Method in class com.azure.maps.route.models.RouteInstruction
-
Returns the
GeoPositioncoordinates of this instruction. - getPointIndex() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the pointIndex property: The index of the point in the list of polyline "points" corresponding to the point of the instruction.
- getPoints() - Method in class com.azure.maps.route.models.RouteLeg
-
Returns a list of
GeoPositioncoordinates. - getProvidedIndex() - Method in class com.azure.maps.route.models.RouteOptimizedWaypoint
-
Get the providedIndex property: Way point index provided by the user.
- getReachableRange() - Method in class com.azure.maps.route.models.RouteRangeResult
-
Get the reachableRange property: Reachable Range.
- getReport() - Method in class com.azure.maps.route.models.RouteDirections
-
Get the report property: Reports the effective settings used in the current call.
- getReport() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the type of
Report - getReport() - Method in class com.azure.maps.route.models.RouteRangeResult
-
Get the report property: Reports the effective settings used in the current call.
- getRoadNumbers() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the roadNumbers property: The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed.
- getRoundaboutExitNumber() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the roundaboutExitNumber property: This indicates which exit to take at a roundabout.
- getRouteDirections() - Method in class com.azure.maps.route.models.RouteDirectionsBatchItem
-
Returns the
RouteDirectionsassociated with the response. - getRouteDirections(RouteDirectionsOptions) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions
- getRouteDirections(RouteDirectionsOptions) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions
- getRouteDirections(RouteDirectionsOptions, RouteDirectionsParameters) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions
- getRouteDirections(RouteDirectionsOptions, RouteDirectionsParameters) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions
- getRouteDirectionsWithResponse(RouteDirectionsOptions) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions
- getRouteDirectionsWithResponse(RouteDirectionsOptions, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions
- getRouteDirectionsWithResponse(RouteDirectionsOptions, RouteDirectionsParameters) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Directions
- getRouteDirectionsWithResponse(RouteDirectionsOptions, RouteDirectionsParameters, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Directions
- getRouteMatrixQuery() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the query matrix used to search for a route.
- getRouteOffsetInMeters() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the routeOffsetInMeters property: Distance from the start of the route to the point of the instruction.
- getRoutePoints() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the route points
- getRouteRange(RouteRangeOptions) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Range
- getRouteRange(RouteRangeOptions) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Range
- getRouteRangeWithResponse(RouteRangeOptions) - Method in class com.azure.maps.route.MapsRouteAsyncClient
-
Get Route Range
- getRouteRangeWithResponse(RouteRangeOptions, Context) - Method in class com.azure.maps.route.MapsRouteClient
-
Get Route Range
- getRouteRepresentationForBestOrder() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the representation for the best order.
- getRoutes() - Method in class com.azure.maps.route.models.RouteDirections
-
Get the routes property: Routes array.
- getRouteType() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the type of route.
- getRouteType() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the
RouteType - getSections() - Method in class com.azure.maps.route.models.MapsSearchRoute
-
Get the sections property: Sections array.
- getSectionType() - Method in class com.azure.maps.route.models.RouteSection
-
Get the sectionType property: Section types of the reported route response.
- getSignpostText() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the signpostText property: The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.
- getSimpleCategory() - Method in class com.azure.maps.route.models.RouteSection
-
Get the simpleCategory property: Type of the incident.
- getStartingPoint() - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Returns the starting point.
- getStartPointIndex() - Method in class com.azure.maps.route.models.RouteSection
-
Get the startPointIndex property: Index of the first point (offset 0) in the route this section applies to.
- getStateCode() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the stateCode property: A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code.
- getStatusCode() - Method in class com.azure.maps.route.models.BatchResultItem
-
Get the statusCode property: HTTP request status code.
- getStatusCode() - Method in class com.azure.maps.route.models.RouteMatrix
-
Get the statusCode property: StatusCode property for the current cell in the input matrix.
- getStreet() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the street property: Street name of the next significant road segment after the maneuver, or of the street that should be followed.
- getSubCauseCode() - Method in class com.azure.maps.route.models.RouteSectionTecCause
-
Get the subCauseCode property: The subcause of the traffic event.
- getSuccessfulRequests() - Method in class com.azure.maps.route.models.BatchResultSummary
-
Get the successfulRequests property: Number of successful requests in the batch.
- getSuccessfulRoutes() - Method in class com.azure.maps.route.models.RouteMatrixSummary
-
Get the successfulRoutes property: Number of successful routes in the response.
- getSummary() - Method in class com.azure.maps.route.models.MapsSearchRoute
-
Get the summary property: Summary object.
- getSummary() - Method in class com.azure.maps.route.models.RouteLeg
-
Get the summary property: Summary object for route section.
- getSummary() - Method in class com.azure.maps.route.models.RouteMatrix
-
Returns a
RouteLegSummarysummarizing this route section. - getSummary() - Method in class com.azure.maps.route.models.RouteMatrixResult
-
Get the summary property: Summary object.
- getSupportingPoints() - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Get the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route. - The provided sequence of supporting points is used as input for route reconstruction. - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>. - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are ignored for the calculation of the reference route's travel time and traffic delay.
- getTec() - Method in class com.azure.maps.route.models.RouteSection
-
Get the tec property: Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.
- getTimeBudgetInSec() - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Returns the time budget in seconds.
- Getting started - Search tag in Overview
- Section
- getTotalRequests() - Method in class com.azure.maps.route.models.BatchResultSummary
-
Get the totalRequests property: Total number of requests in the batch.
- getTotalRoutes() - Method in class com.azure.maps.route.models.RouteMatrixSummary
-
Get the totalRoutes property: Total number of routes requested.
- getTrafficDelayInSeconds() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information.
- getTrafficDelayInSeconds() - Method in class com.azure.maps.route.models.RouteSummary
-
Get the trafficDelayInSeconds property: Estimated delay in seconds caused by the real-time incident(s) according to traffic information.
- getTravelMode() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the travel mode.
- getTravelMode() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the travel mode
TravelMode - getTravelMode() - Method in class com.azure.maps.route.models.RouteSection
-
Get the travelMode property: Travel mode for the calculated route.
- getTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the travelTimeInSeconds property: Estimated travel time up to the point corresponding to routeOffsetInMeters.
- getTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteLegSummary
-
Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic.
- getTravelTimeInSeconds() - Method in class com.azure.maps.route.models.RouteSummary
-
Get the travelTimeInSeconds property: Estimated travel time in seconds property that includes the delay due to real-time traffic.
- getTurnAngleInDegrees() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the turnAngleInDegrees property: Indicates the direction of an instruction.
- getUphillEfficiency() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the uphill efficiency.
- getUseTrafficData() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns whether to use the traffic data
- getValue() - Method in class com.azure.maps.route.models.EffectiveSetting
-
Get the value property: Value of the parameter used.
- getVehicleAxleWeight() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle axle weight.
- getVehicleAxleWeight() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle axle weight.
- getVehicleEngineType() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle engine type.
- getVehicleHeading() - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Returns the vehicle heading.
- getVehicleHeight() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle height in meters.
- getVehicleHeight() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle height.
- getVehicleLength() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle length in meters.
- getVehicleLength() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle length.
- getVehicleLoadType() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle load type.
- getVehicleLoadType() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle load type
- getVehicleMaxSpeed() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle max speed.
- getVehicleMaxSpeed() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle max speed.
- getVehicleWeight() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle weight.
- getVehicleWeight() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle weight.
- getVehicleWidth() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the vehicle width in meters.
- getVehicleWidth() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the vehicle width
- getVersion() - Method in enum com.azure.maps.route.MapsRouteServiceVersion
- getWaitForResults() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Boolean to indicate whether to execute the request synchronously.
- getWindingness() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns the windingness.
- getWindingness() - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Returns the windingness level
- GuidanceInstructionType - Class in com.azure.maps.route.models
-
Type of the instruction, e.g., turn or change of road form.
- GuidanceInstructionType() - Constructor for class com.azure.maps.route.models.GuidanceInstructionType
-
Deprecated.Use the
GuidanceInstructionType.fromString(String)factory method. - GuidanceManeuver - Class in com.azure.maps.route.models
-
A code identifying the maneuver.
- GuidanceManeuver() - Constructor for class com.azure.maps.route.models.GuidanceManeuver
-
Deprecated.Use the
GuidanceManeuver.fromString(String)factory method.
H
- HIGH - Static variable in class com.azure.maps.route.models.InclineLevel
-
high.
- HIGH - Static variable in class com.azure.maps.route.models.WindingnessLevel
-
high.
- httpClient(HttpClient) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The HTTP client used to send the request.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The logging configuration for HTTP requests and responses.
I
- InclineLevel - Class in com.azure.maps.route.models
-
Defines values for InclineLevel.
- InclineLevel() - Constructor for class com.azure.maps.route.models.InclineLevel
-
Deprecated.Use the
InclineLevel.fromString(String)factory method. - Include the recommended packages - Search tag in Overview
- Section
- isCommercialVehicle() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns whether this is a commercial vehicle.
- isGetUseTrafficData() - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Returns whether to use traffic data to calculate the route.
- isPossibleCombineWithNext() - Method in class com.azure.maps.route.models.RouteInstruction
-
Get the possibleCombineWithNext property: It is possible to optionally combine the instruction with the next one.
J
- JAM - Static variable in class com.azure.maps.route.models.RouteDelayReason
-
Traffic jam.
- JunctionType - Class in com.azure.maps.route.models
-
The type of the junction where the maneuver takes place.
- JunctionType() - Constructor for class com.azure.maps.route.models.JunctionType
-
Deprecated.Use the
JunctionType.fromString(String)factory method.
K
- KEEP_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Keep left.
- KEEP_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Keep right.
- Key concepts - Search tag in Overview
- Section
L
- language(String) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the language.
- LEFT - Static variable in class com.azure.maps.route.models.DrivingSide
-
Left side.
- LOCATION_ARRIVAL - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Arrival location.
- LOCATION_DEPARTURE - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Departure location.
- LOCATION_WAYPOINT - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Way point location.
- LOW - Static variable in class com.azure.maps.route.models.InclineLevel
-
low.
- LOW - Static variable in class com.azure.maps.route.models.WindingnessLevel
-
low.
M
- MAJOR - Static variable in class com.azure.maps.route.models.DelayMagnitude
-
Major.
- MAKE_UTURN - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Make a U-turn.
- mapsClientId(String) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets the Azure Maps client id for use with Azure AD Authentication.
- MapsRouteAsyncClient - Class in com.azure.maps.route
-
Initializes a new instance of the asynchronous RouteAsyncClient type.
- MapsRouteClient - Class in com.azure.maps.route
-
Initializes a new instance of the synchronous RouteClient type.
- MapsRouteClientBuilder - Class in com.azure.maps.route
-
Builder class used to instantiate both synchronous and asynchronous
MapsRouteClientclients. - MapsRouteClientBuilder() - Constructor for class com.azure.maps.route.MapsRouteClientBuilder
-
Default constructor for the builder class.
- MapsRouteServiceVersion - Enum in com.azure.maps.route
-
Contains the versions of the Search Service available for the clients.
- MapsSearchRoute - Class in com.azure.maps.route.models
-
The Route model.
- MapsSearchRoute() - Constructor for class com.azure.maps.route.models.MapsSearchRoute
-
Creates an instance of Route class.
- MINOR - Static variable in class com.azure.maps.route.models.DelayMagnitude
-
Minor.
- MODERATE - Static variable in class com.azure.maps.route.models.DelayMagnitude
-
Moderate.
- MOTORCYCLE - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for motorcycles.
- MOTORCYCLE - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for motorcycles.
- MOTORWAY - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are motorways.
- MOTORWAY - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are motorways.
- MOTORWAY_EXIT_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the left exit.
- MOTORWAY_EXIT_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the right exit.
- MOTORWAYS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids motorways.
N
- Next steps - Search tag in Overview
- Section
- NONE - Static variable in class com.azure.maps.route.models.ComputeTravelTime
-
Does not compute additional travel times.
- NONE - Static variable in class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Includes only the optimized waypoint indices but does not include the route geometry in the response.
- NORMAL - Static variable in class com.azure.maps.route.models.InclineLevel
-
normal.
- NORMAL - Static variable in class com.azure.maps.route.models.WindingnessLevel
-
normal.
O
- OTHER - Static variable in class com.azure.maps.route.models.RouteDelayReason
-
Other.
- OTHER - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The given mode of transport is not possible in this section.
- OTHER_HAZMAT_EXPLOSIVE - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Explosives.
- OTHER_HAZMAT_GENERAL - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Miscellaneous.
- OTHER_HAZMAT_HARMFUL_TO_WATER - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Harmful to water.
P
- PEDESTRIAN - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are only suited for pedestrians.
- PEDESTRIAN - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for pedestrians, including the use of sidewalks.
- PEDESTRIAN - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are only suited for pedestrians.
- PEDESTRIAN - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for pedestrians, including the use of sidewalks.
- pipeline(HttpPipeline) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The HTTP pipeline to send requests through.
- POLYLINE - Static variable in class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Includes route geometry in the response.
- Prerequisites - Search tag in Overview
- Section
R
- REGULAR - Static variable in class com.azure.maps.route.models.JunctionType
-
regular.
- Report - Class in com.azure.maps.route.models
-
Defines values for Report.
- Report() - Constructor for class com.azure.maps.route.models.Report
-
Deprecated.Use the
Report.fromString(String)factory method. - retryOptions(RetryOptions) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets retry options
- retryPolicy(RetryPolicy) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- RIGHT - Static variable in class com.azure.maps.route.models.DrivingSide
-
Right side.
- ROAD_CHANGE - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Road Change.
- ROAD_CLOSURE - Static variable in class com.azure.maps.route.models.RouteDelayReason
-
Road closure.
- ROAD_WORK - Static variable in class com.azure.maps.route.models.RouteDelayReason
-
Road work.
- ROUNDABOUT - Static variable in class com.azure.maps.route.models.JunctionType
-
roundabout.
- ROUNDABOUT_BACK - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Go around the roundabout.
- ROUNDABOUT_CROSS - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Cross the roundabout.
- ROUNDABOUT_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
At the roundabout take the exit on the left.
- ROUNDABOUT_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
At the roundabout take the exit on the right.
- RouteAvoidType - Class in com.azure.maps.route.models
-
Defines values for RouteAvoidType.
- RouteAvoidType() - Constructor for class com.azure.maps.route.models.RouteAvoidType
-
Deprecated.Use the
RouteAvoidType.fromString(String)factory method. - RouteDelayReason - Class in com.azure.maps.route.models
-
Type of the incident.
- RouteDelayReason() - Constructor for class com.azure.maps.route.models.RouteDelayReason
-
Deprecated.Use the
RouteDelayReason.fromString(String)factory method. - RouteDirections - Class in com.azure.maps.route.models
-
This object is returned from a successful Route Directions call.
- RouteDirections() - Constructor for class com.azure.maps.route.models.RouteDirections
-
Creates an instance of RouteDirections class.
- RouteDirectionsBatchItem - Class in com.azure.maps.route.models
-
An item returned from Route Directions Batch service call.
- RouteDirectionsBatchItem() - Constructor for class com.azure.maps.route.models.RouteDirectionsBatchItem
-
Creates an instance of RouteDirectionsBatchItem class.
- RouteDirectionsBatchResult - Class in com.azure.maps.route.models
-
Route Directions Batch Result
- RouteDirectionsBatchResult() - Constructor for class com.azure.maps.route.models.RouteDirectionsBatchResult
-
Creates a new instance of
RouteDirectionsBatchResult. - RouteDirectionsOptions - Class in com.azure.maps.route.models
-
Route Directions Options
- RouteDirectionsOptions(List<GeoPosition>) - Constructor for class com.azure.maps.route.models.RouteDirectionsOptions
-
Builds a new set of options for the Route Directions call.
- RouteDirectionsParameters - Class in com.azure.maps.route.models
-
Post body parameters for Route directions.
- RouteDirectionsParameters() - Constructor for class com.azure.maps.route.models.RouteDirectionsParameters
-
Creates a new instance of
RouteDirectionsParameters. - RouteGuidance - Class in com.azure.maps.route.models
-
Contains guidance related elements.
- RouteGuidance() - Constructor for class com.azure.maps.route.models.RouteGuidance
-
Creates an instance of RouteGuidance class.
- RouteInstruction - Class in com.azure.maps.route.models
-
A set of attributes describing a maneuver, e.g.
- RouteInstruction() - Constructor for class com.azure.maps.route.models.RouteInstruction
-
Creates an instance of RouteInstruction class.
- RouteInstructionGroup - Class in com.azure.maps.route.models
-
Groups a sequence of instruction elements which are related to each other.
- RouteInstructionGroup() - Constructor for class com.azure.maps.route.models.RouteInstructionGroup
-
Creates an instance of RouteInstructionGroup class.
- RouteInstructionsType - Class in com.azure.maps.route.models
-
Defines values for RouteInstructionsType.
- RouteInstructionsType() - Constructor for class com.azure.maps.route.models.RouteInstructionsType
-
Deprecated.Use the
RouteInstructionsType.fromString(String)factory method. - RouteLeg - Class in com.azure.maps.route.models
-
A description of a part of a route, comprised of a list of points.
- RouteLeg() - Constructor for class com.azure.maps.route.models.RouteLeg
-
Creates an instance of RouteLeg class.
- RouteLegSummary - Class in com.azure.maps.route.models
-
Summary object for route section.
- RouteLegSummary() - Constructor for class com.azure.maps.route.models.RouteLegSummary
-
Creates an instance of RouteLegSummary class.
- RouteMatrix - Class in com.azure.maps.route.models
-
Matrix result object.
- RouteMatrix() - Constructor for class com.azure.maps.route.models.RouteMatrix
-
Creates an instance of RouteMatrix class.
- RouteMatrixOptions - Class in com.azure.maps.route.models
-
Represents the options for requesting a route matrix.
- RouteMatrixOptions(RouteMatrixQuery) - Constructor for class com.azure.maps.route.models.RouteMatrixOptions
-
Constructs a
RouteMatrixOptionswith the requiredRouteMatrixQueryparameters. - RouteMatrixQuery - Class in com.azure.maps.route.models
-
An object with a matrix of coordinates.
- RouteMatrixQuery() - Constructor for class com.azure.maps.route.models.RouteMatrixQuery
-
Creates a new instance of
RouteMatrixQuery. - RouteMatrixResult - Class in com.azure.maps.route.models
-
Route Matrix result.
- RouteMatrixResult() - Constructor for class com.azure.maps.route.models.RouteMatrixResult
-
Creates a new instance of
RouteMatrixResult. - RouteMatrixSummary - Class in com.azure.maps.route.models
-
Summary object.
- RouteMatrixSummary() - Constructor for class com.azure.maps.route.models.RouteMatrixSummary
-
Creates an instance of RouteMatrixSummary class.
- RouteOptimizedWaypoint - Class in com.azure.maps.route.models
-
Optimized way point object.
- RouteOptimizedWaypoint() - Constructor for class com.azure.maps.route.models.RouteOptimizedWaypoint
-
Creates an instance of RouteOptimizedWaypoint class.
- RouteRange - Class in com.azure.maps.route.models
-
Reachable Range.
- RouteRange() - Constructor for class com.azure.maps.route.models.RouteRange
-
Creates an instance of RouteRange class.
- RouteRangeOptions - Class in com.azure.maps.route.models
-
Options class for a get route range call.
- RouteRangeOptions(GeoPosition) - Constructor for class com.azure.maps.route.models.RouteRangeOptions
-
Builds a new
RouteRangeOptions. - RouteRangeOptions(GeoPosition, Duration) - Constructor for class com.azure.maps.route.models.RouteRangeOptions
-
Builds a new
RouteRangeOptions. - RouteRangeResult - Class in com.azure.maps.route.models
-
This object is returned from a successful Route Reachable Range call.
- RouteRangeResult() - Constructor for class com.azure.maps.route.models.RouteRangeResult
-
Creates an instance of RouteRangeResult class.
- RouteReport - Class in com.azure.maps.route.models
-
Reports the effective settings used in the current call.
- RouteReport() - Constructor for class com.azure.maps.route.models.RouteReport
-
Creates an instance of RouteReport class.
- RouteRepresentationForBestOrder - Class in com.azure.maps.route.models
-
Defines values for RouteRepresentationForBestOrder.
- RouteRepresentationForBestOrder() - Constructor for class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Deprecated.Use the
RouteRepresentationForBestOrder.fromString(String)factory method. - RouteSection - Class in com.azure.maps.route.models
-
Route sections contain additional information about parts of a route.
- RouteSection() - Constructor for class com.azure.maps.route.models.RouteSection
-
Creates an instance of RouteSection class.
- RouteSectionTec - Class in com.azure.maps.route.models
-
Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.
- RouteSectionTec() - Constructor for class com.azure.maps.route.models.RouteSectionTec
-
Creates an instance of RouteSectionTec class.
- RouteSectionTecCause - Class in com.azure.maps.route.models
-
The cause of the traffic event.
- RouteSectionTecCause() - Constructor for class com.azure.maps.route.models.RouteSectionTecCause
-
Creates an instance of RouteSectionTecCause class.
- RouteSectionType - Class in com.azure.maps.route.models
-
Section types of the reported route response.
- RouteSectionType() - Constructor for class com.azure.maps.route.models.RouteSectionType
-
Deprecated.Use the
RouteSectionType.fromString(String)factory method. - RouteSummary - Class in com.azure.maps.route.models
-
Summary object.
- RouteSummary() - Constructor for class com.azure.maps.route.models.RouteSummary
-
Creates an instance of RouteSummary class.
- RouteTravelMode - Class in com.azure.maps.route.models
-
Travel mode for the calculated route.
- RouteTravelMode() - Constructor for class com.azure.maps.route.models.RouteTravelMode
-
Deprecated.Use the
RouteTravelMode.fromString(String)factory method. - RouteType - Class in com.azure.maps.route.models
-
Defines values for RouteType.
- RouteType() - Constructor for class com.azure.maps.route.models.RouteType
-
Deprecated.Use the
RouteType.fromString(String)factory method.
S
- SectionType - Class in com.azure.maps.route.models
-
Defines values for SectionType.
- SectionType() - Constructor for class com.azure.maps.route.models.SectionType
-
Deprecated.Use the
SectionType.fromString(String)factory method. - serviceVersion(MapsRouteServiceVersion) - Method in class com.azure.maps.route.MapsRouteClientBuilder
-
Sets the
MapsRouteServiceVersionthat is used when making API requests. - setAccelerationEfficiency(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the acceleration efficiency.
- setAllowVignette(List<String>) - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Set the allowVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g.
- setAlternativeType(AlternativeRouteType) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the type of the alternative route
- setArriveAt(OffsetDateTime) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the arrival time.
- setArriveAt(OffsetDateTime) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the arrival time.
- setAuxiliaryPowerInKw(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the auxiliary power.
- setAuxiliaryPowerInLitersPerHour(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the auxiliary power in liters per hour.
- setAvoid(List<RouteAvoidType>) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the list of route types to avoid.
- setAvoid(List<RouteAvoidType>) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Avoid certain types of routes.
- setAvoidAreas(GeoPolygonCollection) - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Set the avoidAreas property: A GeoJSON MultiPolygon representing list of areas to avoid.
- setAvoidVignette(List<String>) - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Set the avoidVignette property: This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g.
- setBatchId(String) - Method in class com.azure.maps.route.models.RouteDirectionsBatchResult
-
Sets the matrix id for this request.
- setCauses(List<RouteSectionTecCause>) - Method in class com.azure.maps.route.models.RouteSectionTec
-
Set the causes property: Causes array.
- setCommercialVehicle(Boolean) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets whether this is a commercial vehicle.
- setComputeBestWaypointOrder(Boolean) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets whether to use the best waypoint order.
- setComputeTravelTime(ComputeTravelTime) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the type of computation for the travel time.
- setComputeTravelTime(ComputeTravelTime) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Options for computing the travel time.
- setConstantSpeedConsumptionInKwHPerHundredKm(String) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the constant speed energy consumption.
- setConstantSpeedConsumptionInLitersPerHundredKm(String) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the constant speed fuel consumption.
- setCurrentChargeInKwH(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the current charge.
- setCurrentFuelInLiters(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the current fuel in liters.
- setDecelerationEfficiency(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the deceleration efficiency.
- setDepartAt(OffsetDateTime) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the departure time.
- setDepartAt(OffsetDateTime) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the departure time.
- setDestinations(GeoPointCollection) - Method in class com.azure.maps.route.models.RouteMatrixQuery
-
Set the destinations property: A valid `GeoJSON MultiPoint` geometry type.
- setDistanceBudgetInMeters(Double) - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Sets the distance budget in meters.
- setDownhillEfficiency(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the downhill efficiency.
- setEnergyBudgetInKwH(Double) - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Sets the energy budget in KwH
- setFilterSectionType(SectionType) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the type of
SectionTypeused for filtering. - setFilterSectionType(SectionType) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Filter by certain
SectionType - setFuelBudgetInLiters(Double) - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Sets the fuel budget in liters.
- setFuelEnergyDensityInMegajoulesPerLiter(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the fuel energy density.
- setInclineLevel(InclineLevel) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the incline level.
- setInclineLevel(InclineLevel) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the incline level
InclineLevel - setInstructionsType(RouteInstructionsType) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the type of route instructions.
- setInstructionType(GuidanceInstructionType) - Method in class com.azure.maps.route.models.RouteInstruction
-
Set the instructionType property: Type of the instruction, e.g., turn or change of road form.
- setMatrixId(String) - Method in class com.azure.maps.route.models.RouteMatrixResult
-
Sets the matrix id for this request.
- setMaxAlternatives(Integer) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the maximum number of alternative routes.
- setMaxChargeInKwH(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the max charge.
- setMinDeviationDistance(Integer) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the minimum deviation distance.
- setMinDeviationTime(Integer) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the minimal deviation time.
- setOrigins(GeoPointCollection) - Method in class com.azure.maps.route.models.RouteMatrixQuery
-
Set the origins property: A valid `GeoJSON MultiPoint` geometry type.
- setReachableRange(RouteRange) - Method in class com.azure.maps.route.models.RouteRangeResult
-
Set the reachableRange property: Reachable Range.
- setReport(Report) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the type of
Report - setReport(RouteReport) - Method in class com.azure.maps.route.models.RouteDirections
-
Set the report property: Reports the effective settings used in the current call.
- setReport(RouteReport) - Method in class com.azure.maps.route.models.RouteRangeResult
-
Set the report property: Reports the effective settings used in the current call.
- setRouteMatrixQuery(RouteMatrixQuery) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the
RouteMatrixQueryrepresenting the desired route matrix. - setRoutePoints(List<GeoPosition>) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the route points
- setRouteRepresentationForBestOrder(RouteRepresentationForBestOrder) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the representation for the best order.
- setRouteType(RouteType) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the type of route.
- setRouteType(RouteType) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the route type
RouteType - setStartingPoint(GeoPosition) - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Sets the starting point.
- setSupportingPoints(GeoCollection) - Method in class com.azure.maps.route.models.RouteDirectionsParameters
-
Set the supportingPoints property: A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route. - The provided sequence of supporting points is used as input for route reconstruction. - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>. - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are ignored for the calculation of the reference route's travel time and traffic delay.
- setTec(RouteSectionTec) - Method in class com.azure.maps.route.models.RouteSection
-
Set the tec property: Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.
- setTimeBudgetInSec(Duration) - Method in class com.azure.maps.route.models.RouteRangeOptions
-
Sets the time budget in seconds.
- setTravelMode(TravelMode) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the travel mode.
- setTravelMode(TravelMode) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the travel mode
TravelMode - setUphillEfficiency(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the uphill efficiency.
- setUseTrafficData(Boolean) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets whether to use traffic data to calculate the route.
- setUseTrafficData(Boolean) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Use traffic data when calculating the range.
- setVehicleAxleWeight(Integer) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle axle weight.
- setVehicleAxleWeight(Integer) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle axle weight.
- setVehicleEngineType(VehicleEngineType) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle engine type.
- setVehicleHeading(Integer) - Method in class com.azure.maps.route.models.RouteDirectionsOptions
-
Sets the vehicle heading.
- setVehicleHeight(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle height.
- setVehicleHeight(Double) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle height.
- setVehicleLength(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle length.
- setVehicleLength(Double) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle length.
- setVehicleLoadType(VehicleLoadType) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle load type.
- setVehicleLoadType(VehicleLoadType) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle load type
VehicleLoadType - setVehicleMaxSpeed(Integer) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle max speed.
- setVehicleMaxSpeed(Integer) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle max speed.
- setVehicleWeight(Integer) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle weight.
- setVehicleWeight(Integer) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle weight.
- setVehicleWidth(Double) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the vehicle width.
- setVehicleWidth(Double) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the vehicle width.
- setWaitForResults(Boolean) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Wait for the results of the call
- setWindingness(WindingnessLevel) - Method in class com.azure.maps.route.models.BaseRouteOptions
-
Sets the windingness.
- setWindingness(WindingnessLevel) - Method in class com.azure.maps.route.models.RouteMatrixOptions
-
Sets the windingness level
Windingness - SHARP_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Turn sharp left.
- SHARP_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Turn sharp right.
- SHORTEST - Static variable in class com.azure.maps.route.models.RouteType
-
The shortest route by distance.
- STRAIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Keep straight on.
- SUMMARY_ONLY - Static variable in class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Summary as per polyline but excluding the point geometry elements for the routes in the response.
- SWITCH_MAIN_ROAD - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Switch to the main road.
- SWITCH_PARALLEL_ROAD - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Switch to the parallel road.
T
- TAGGED - Static variable in class com.azure.maps.route.models.RouteInstructionsType
-
Returns raw instruction data with tagged human-readable messages to permit formatting.
- TAKE_EXIT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the exit.
- TAKE_FERRY - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Take the ferry.
- TAXI - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for taxis.
- TAXI - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for taxis.
- TEXT - Static variable in class com.azure.maps.route.models.RouteInstructionsType
-
Returns raw instructions data with human-readable messages in plain text.
- THRILLING - Static variable in class com.azure.maps.route.models.RouteType
-
Includes interesting or challenging roads and uses as few motorways as possible.
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.BatchResultItem
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.BatchResultSummary
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.EffectiveSetting
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.MapsSearchRoute
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteDirections
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteDirectionsBatchItem
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteDirectionsBatchResult
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteGuidance
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteInstruction
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteInstructionGroup
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteLeg
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteLegSummary
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteMatrix
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteMatrixResult
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteMatrixSummary
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteOptimizedWaypoint
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteRange
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteRangeResult
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteReport
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteSection
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteSectionTec
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteSectionTecCause
- toJson(JsonWriter) - Method in class com.azure.maps.route.models.RouteSummary
- TOLL_ROAD - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that require a toll to be payed.
- TOLL_ROAD - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that require a toll to be paid.
- TOLL_ROADS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids toll roads.
- TOLL_VIGNETTE - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that require a toll vignette to be present.
- TOLL_VIGNETTE - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that require a toll vignette to be present.
- TRAFFIC - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that contain traffic information.
- TRAFFIC - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that contain traffic information.
- TRAVEL_MODE - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections in relation to the request parameter `travelMode`.
- TRAVEL_MODE - Static variable in class com.azure.maps.route.models.SectionType
-
Sections in relation to the request parameter `travelMode`.
- TravelMode - Class in com.azure.maps.route.models
-
Defines values for TravelMode.
- TravelMode() - Constructor for class com.azure.maps.route.models.TravelMode
-
Deprecated.Use the
TravelMode.fromString(String)factory method. - Troubleshooting - Search tag in Overview
- Section
- TRUCK - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for commercial vehicles, like for trucks.
- TRUCK - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for commercial vehicles, like for trucks.
- TRY_MAKE_UTURN - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Try to make a U-turn.
- TUNNEL - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are tunnels.
- TUNNEL - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are tunnels.
- TURN - Static variable in class com.azure.maps.route.models.GuidanceInstructionType
-
Turn.
- TURN_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Turn left.
- TURN_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
Turn right.
U
- UNDEFINED - Static variable in class com.azure.maps.route.models.DelayMagnitude
-
Undefined, used for road closures and other indefinite delays.
- UNKNOWN - Static variable in class com.azure.maps.route.models.DelayMagnitude
-
Unknown.
- UNPAVED_ROADS - Static variable in class com.azure.maps.route.models.RouteAvoidType
-
Avoids unpaved roads.
- URBAN - Static variable in class com.azure.maps.route.models.RouteSectionType
-
Sections of the route that are located within urban areas.
- URBAN - Static variable in class com.azure.maps.route.models.SectionType
-
Sections of the route that are located within urban areas.
- US_HAZMAT_CLASS1 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Explosives.
- US_HAZMAT_CLASS2 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Compressed gas.
- US_HAZMAT_CLASS3 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Flammable liquids.
- US_HAZMAT_CLASS4 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Flammable solids.
- US_HAZMAT_CLASS5 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Oxidizers.
- US_HAZMAT_CLASS6 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Poisons.
- US_HAZMAT_CLASS7 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Radioactive.
- US_HAZMAT_CLASS8 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Corrosives.
- US_HAZMAT_CLASS9 - Static variable in class com.azure.maps.route.models.VehicleLoadType
-
Miscellaneous.
V
- V1_0 - Enum constant in enum com.azure.maps.route.MapsRouteServiceVersion
-
Service version
1.0. - valueOf(String) - Static method in enum com.azure.maps.route.MapsRouteServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.maps.route.MapsRouteServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.maps.route.models.AlternativeRouteType
-
Gets known AlternativeRouteType values.
- values() - Static method in class com.azure.maps.route.models.ComputeTravelTime
-
Gets known ComputeTravelTime values.
- values() - Static method in class com.azure.maps.route.models.DelayMagnitude
-
Gets known DelayMagnitude values.
- values() - Static method in class com.azure.maps.route.models.DrivingSide
-
Gets known DrivingSide values.
- values() - Static method in class com.azure.maps.route.models.GuidanceInstructionType
-
Gets known GuidanceInstructionType values.
- values() - Static method in class com.azure.maps.route.models.GuidanceManeuver
-
Gets known GuidanceManeuver values.
- values() - Static method in class com.azure.maps.route.models.InclineLevel
-
Gets known InclineLevel values.
- values() - Static method in class com.azure.maps.route.models.JunctionType
-
Gets known JunctionType values.
- values() - Static method in class com.azure.maps.route.models.Report
-
Gets known Report values.
- values() - Static method in class com.azure.maps.route.models.RouteAvoidType
-
Gets known RouteAvoidType values.
- values() - Static method in class com.azure.maps.route.models.RouteDelayReason
-
Gets known SimpleCategory values.
- values() - Static method in class com.azure.maps.route.models.RouteInstructionsType
-
Gets known RouteInstructionsType values.
- values() - Static method in class com.azure.maps.route.models.RouteRepresentationForBestOrder
-
Gets known RouteRepresentationForBestOrder values.
- values() - Static method in class com.azure.maps.route.models.RouteSectionType
-
Gets known ResponseSectionType values.
- values() - Static method in class com.azure.maps.route.models.RouteTravelMode
-
Gets known ResponseTravelMode values.
- values() - Static method in class com.azure.maps.route.models.RouteType
-
Gets known RouteType values.
- values() - Static method in class com.azure.maps.route.models.SectionType
-
Gets known SectionType values.
- values() - Static method in class com.azure.maps.route.models.TravelMode
-
Gets known TravelMode values.
- values() - Static method in class com.azure.maps.route.models.VehicleEngineType
-
Gets known VehicleEngineType values.
- values() - Static method in class com.azure.maps.route.models.VehicleLoadType
-
Gets known VehicleLoadType values.
- values() - Static method in class com.azure.maps.route.models.WindingnessLevel
-
Gets known WindingnessLevel values.
- VAN - Static variable in class com.azure.maps.route.models.RouteTravelMode
-
The returned routes are optimized for vans.
- VAN - Static variable in class com.azure.maps.route.models.TravelMode
-
The returned routes are optimized for vans.
- VehicleEngineType - Class in com.azure.maps.route.models
-
Defines values for VehicleEngineType.
- VehicleEngineType() - Constructor for class com.azure.maps.route.models.VehicleEngineType
-
Deprecated.Use the
VehicleEngineType.fromString(String)factory method. - VehicleLoadType - Class in com.azure.maps.route.models
-
Defines values for VehicleLoadType.
- VehicleLoadType() - Constructor for class com.azure.maps.route.models.VehicleLoadType
-
Deprecated.Use the
VehicleLoadType.fromString(String)factory method.
W
- WAYPOINT_LEFT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have reached the waypoint.
- WAYPOINT_REACHED - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have reached the waypoint.
- WAYPOINT_RIGHT - Static variable in class com.azure.maps.route.models.GuidanceManeuver
-
You have reached the waypoint.
- WindingnessLevel - Class in com.azure.maps.route.models
-
Defines values for WindingnessLevel.
- WindingnessLevel() - Constructor for class com.azure.maps.route.models.WindingnessLevel
-
Deprecated.Use the
WindingnessLevel.fromString(String)factory method.
All Classes and Interfaces|All Packages
AlternativeRouteType.fromString(String)factory method.