Package com.azure.maps.search.models

Class SearchAlongRouteOptions

java.lang.Object

com.azure.maps.search.models.BaseSearchGeometryOptions<SearchAlongRouteOptions>

com.azure.maps.search.models.SearchAlongRouteOptions

public final class SearchAlongRouteOptions
extends BaseSearchGeometryOptions<SearchAlongRouteOptions>

Class holding optional parameters for Search along a route.

Constructor Summary

Constructors

Constructor	Description
SearchAlongRouteOptions(String query, int maxDetourTime)	Create search along route options.
SearchAlongRouteOptions(String query, int maxDetourTime, com.azure.core.models.GeoLineString route)	Create search along route options.

Method Summary

Modifier and Type	Method	Description
List<String>	getBrandFilter()	Returns the brand filter.
List<ElectricVehicleConnector>	getElectricVehicleConnectorFilter()	Returns the electric vehicle connector filter.
int	getMaxDetourTime()	Returns the max detour time.
com.azure.core.models.GeoLineString	getRoute()	Returns the route used in the search.
SearchAlongRouteOptions	setBrandFilter(List<String> brandFilter)	Sets the brand filter.
SearchAlongRouteOptions	setElectricVehicleConnectorFilter(List<ElectricVehicleConnector> electricVehicleConnectorFilter)	Sets the electric vehicle connector filter.
SearchAlongRouteOptions	setMaxDetourTime(int maxDetourTime)	Sets the max detour time.
SearchAlongRouteOptions	setRoute(com.azure.core.models.GeoLineString route)	Sets the route.

Methods inherited from class com.azure.maps.search.models.BaseSearchGeometryOptions

getCategoryFilter, getLocalizedMapView, getOperatingHours, getQuery, getTop, setCategoryFilter, setLocalizedMapView, setOperatingHours, setQuery, setTop

Methods inherited from class java.lang.Object

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

Constructor Details

SearchAlongRouteOptions

public SearchAlongRouteOptions(String query,
 int maxDetourTime)

Create search along route options.

Parameters:

query - the search query

maxDetourTime - the maximum detour time allowed

SearchAlongRouteOptions

public SearchAlongRouteOptions(String query,
 int maxDetourTime,
 com.azure.core.models.GeoLineString route)

Create search along route options.

Parameters:

query - the search query

maxDetourTime - the maximum detour time allowed

route - the GeoLineString geometry representing the route

Method Details

getBrandFilter

public List<String> getBrandFilter()

Returns the brand filter.

Returns:

the brand filter.

getMaxDetourTime

public int getMaxDetourTime()

Returns the max detour time.

Returns:

the max detour time.

getRoute

public com.azure.core.models.GeoLineString getRoute()

Returns the route used in the search.

Returns:

GeoJsonLineString return the route used in the search.

getElectricVehicleConnectorFilter

public List<ElectricVehicleConnector> getElectricVehicleConnectorFilter()

Returns the electric vehicle connector filter.

Returns:

the electric vehicle connector filter.

setBrandFilter

public SearchAlongRouteOptions setBrandFilter(List<String> brandFilter)

Sets the brand filter.

Parameters:

brandFilter - the brand filter.

Returns:

a reference to this SearchAlongRouteOptions

setRoute

public SearchAlongRouteOptions setRoute(com.azure.core.models.GeoLineString route)

Sets the route.

Parameters:

route - the GeoLineString geometry representing the route.

Returns:

a reference to this SearchAlongRouteOptions

setElectricVehicleConnectorFilter

public SearchAlongRouteOptions setElectricVehicleConnectorFilter(List<ElectricVehicleConnector> electricVehicleConnectorFilter)

Sets the electric vehicle connector filter.

Parameters:

electricVehicleConnectorFilter - the electric vehicle connector filter.

Returns:

a reference to this SearchAlongRouteOptions

setMaxDetourTime

public SearchAlongRouteOptions setMaxDetourTime(int maxDetourTime)

Sets the max detour time.

Parameters:

maxDetourTime - the max detour time.

Returns:

a reference to this SearchAlongRouteOptions