Azure Maps SDK Search client library for Java - version 1.0.0-beta.1
Azure Maps SDK Search client library for Java.
This package contains the Azure Maps SDK Search client library which contains Azure Maps Search APIs. For documentation on how to use this package, please see Azure Maps Search SDK for Java.
Source code | API reference documentation | REST API documentation | Product documentation | Samples
Documentation
Various documentation is available to help you get started
Getting started
Prerequisites
- Java Development Kit (JDK) with version 8 or above
- Azure Subscription
Adding the package to your product
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-maps-search</artifactId>
<version>1.0.0-beta.1</version>
</dependency>
Include the recommended packages
Azure Maps Libraries require a TokenCredential implementation for authentication and an HttpClient implementation for HTTP client.
Azure Identity package and Azure Core Netty HTTP package provide the default implementation.
Authentication
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETorAZURE_CLIENT_CERTIFICATE_PATHfor client secret or client certificate.
In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.
With above configuration, azure client can be authenticated by following code:
// Authenticates using Azure AD building a default credential
// This will look for AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET env variables
DefaultAzureCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
// Creates a builder
MapsSearchClientBuilder builder = new MapsSearchClientBuilder();
builder.credential(tokenCredential);
builder.mapsClientId(System.getenv("MAPS_CLIENT_ID"));
builder.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS));
// Builds a client
MapsSearchClient client = builder.buildClient();
The sample code assumes global Azure. Please change AzureEnvironment.AZURE variable if otherwise.
See Authentication for more options.
Key concepts
See API design for general introduction on design and key concepts on Azure Management Libraries.
Examples
Get Polygons
SearchAddressResult results = client.fuzzySearch(
new FuzzySearchOptions("1 Microsoft Way", new GeoPosition(-74.011454, 40.706270))
.setTop(5));
Response<SearchAddressResult> response = client.fuzzySearchWithResponse(
new FuzzySearchOptions("Monaco").setEntityType(GeographicEntityType.COUNTRY)
.setTop(5), null);
String id = response.getValue().getResults().get(0).getDataSource().getGeometry();
List<String> ids = results.getResults().stream()
.filter(item -> item.getDataSource() != null && item.getDataSource().getGeometry() != null)
.map(item -> item.getDataSource().getGeometry())
.collect(Collectors.toList());
ids.add(id);
if (ids != null && !ids.isEmpty()) {
System.out.println("Get Polygon: " + ids);
client.getPolygons(ids);
client.getPolygonsWithResponse(ids, null).getValue().getClass();
}
Fuzzy Search
System.out.println("Search Fuzzy:");
// simple
client.fuzzySearch(new FuzzySearchOptions("starbucks"));
// with options
SearchAddressResult results = client.fuzzySearch(
new FuzzySearchOptions("1 Microsoft Way", new GeoPosition(-74.011454, 40.706270))
.setTop(5));
// with response
Response<SearchAddressResult> response = client.fuzzySearchWithResponse(
new FuzzySearchOptions("Monaco").setEntityType(GeographicEntityType.COUNTRY)
.setTop(5), null);
Search Point Of Interest
System.out.println("Search Points of Interest:");
// coordinates
client.searchPointOfInterest(
new SearchPointOfInterestOptions("pizza", new GeoPosition(-121.97483, 36.98844)));
// options
client.searchPointOfInterest(
new SearchPointOfInterestOptions("pizza", new GeoPosition(-121.97483, 36.98844))
.setTop(10)
.setOperatingHours(OperatingHoursRange.NEXT_SEVEN_DAYS));
// with response
client.searchPointOfInterestWithResponse(
new SearchPointOfInterestOptions("pizza", new GeoPosition(-121.97483, 36.98844))
.setTop(10)
.setOperatingHours(OperatingHoursRange.NEXT_SEVEN_DAYS),
null).getStatusCode();
Search Nearby Point Of Interest
System.out.println("Search Nearby:");
// options
client.searchNearbyPointsOfInterest(
new SearchNearbyPointsOfInterestOptions(new GeoPosition(-74.011454, 40.706270))
.setCountryFilter(Arrays.asList("US"))
.setTop(10));
// response
client.searchNearbyPointsOfInterestWithResponse(
new SearchNearbyPointsOfInterestOptions(new GeoPosition(-74.011454, 40.706270))
.setCountryFilter(Arrays.asList("US"))
.setTop(10),
null).getStatusCode();
Search Point Of Interest Category
System.out.println("Search Nearby:");
// options
client.searchNearbyPointsOfInterest(
new SearchNearbyPointsOfInterestOptions(new GeoPosition(-74.011454, 40.706270))
.setCountryFilter(Arrays.asList("US"))
.setTop(10));
// response
client.searchNearbyPointsOfInterestWithResponse(
new SearchNearbyPointsOfInterestOptions(new GeoPosition(-74.011454, 40.706270))
.setCountryFilter(Arrays.asList("US"))
.setTop(10),
null).getStatusCode();
Get Point Of Interest Category Tree
System.out.println("Get Search POI Category Tree:");
client.getPointOfInterestCategoryTree();
Search Address
System.out.println("Search Address:");
// simple
client.searchAddress(
new SearchAddressOptions("15127 NE 24th Street, Redmond, WA 98052"));
// options
client.searchAddress(
new SearchAddressOptions("1 Main Street")
.setCoordinates(new GeoPosition(-74.011454, 40.706270))
.setRadiusInMeters(40000)
.setTop(5));
// complete
client.searchAddressWithResponse(
new SearchAddressOptions("1 Main Street")
.setCoordinates(new GeoPosition(-74.011454, 40.706270))
.setRadiusInMeters(40000)
.setTop(5), null).getStatusCode();
Reverse Search Address
System.out.println("Search Address Reverse:");
// simple
client.reverseSearchAddress(
new ReverseSearchAddressOptions(new GeoPosition(-121.89, 37.337)));
client.reverseSearchAddress(
new ReverseSearchAddressOptions(new GeoPosition(-121.89, 37.337)));
// options
client.reverseSearchAddress(
new ReverseSearchAddressOptions(new GeoPosition(-121.89, 37.337))
.setIncludeSpeedLimit(true)
.setEntityType(GeographicEntityType.COUNTRY_SECONDARY_SUBDIVISION) // returns only city
);
// complete
client.reverseSearchAddressWithResponse(
new ReverseSearchAddressOptions(new GeoPosition(-121.89, 37.337))
.setIncludeSpeedLimit(true)
.setEntityType(GeographicEntityType.COUNTRY_SECONDARY_SUBDIVISION),
null).getStatusCode();
Reverse Search Cross Street Address
System.out.println("Revere Search Cross Street Address:");
// options
client.reverseSearchCrossStreetAddress(
new ReverseSearchCrossStreetAddressOptions(new GeoPosition(-121.89, 37.337)));
// options
client.reverseSearchCrossStreetAddress(
new ReverseSearchCrossStreetAddressOptions(new GeoPosition(-121.89, 37.337))
.setTop(2)
.setHeading(5));
// complete
client.reverseSearchCrossStreetAddressWithResponse(
new ReverseSearchCrossStreetAddressOptions(new GeoPosition(-121.89, 37.337))
.setTop(2)
.setHeading(5),
null).getStatusCode();
Search Structured Address
System.out.println("Search Address Structured:");
// simple
client.searchStructuredAddress(new StructuredAddress("US")
.setPostalCode("98121")
.setStreetNumber("15127")
.setStreetName("NE 24th Street")
.setMunicipality("Redmond")
.setCountrySubdivision("WA"), null);
// complete
client.searchStructuredAddressWithResponse(new StructuredAddress("US")
.setPostalCode("98121")
.setStreetNumber("15127")
.setStreetName("NE 24th Street")
.setMunicipality("Redmond")
.setCountrySubdivision("WA"),
new SearchStructuredAddressOptions()
.setTop(2)
.setRadiusInMeters(1000),
null).getStatusCode();
Search Inside Geometry
System.out.println("Search Inside Geometry");
// create GeoPolygon
List<GeoPosition> coordinates = new ArrayList<>();
coordinates.add(new GeoPosition(-122.43576049804686, 37.7524152343544));
coordinates.add(new GeoPosition(-122.43301391601562, 37.70660472542312));
coordinates.add(new GeoPosition(-122.36434936523438, 37.712059855877314));
coordinates.add(new GeoPosition(-122.43576049804686, 37.7524152343544));
GeoLinearRing ring = new GeoLinearRing(coordinates);
GeoPolygon polygon = new GeoPolygon(ring);
// simple
client.searchInsideGeometry(
new SearchInsideGeometryOptions("Leland Avenue", polygon));
// options
client.searchInsideGeometry(
new SearchInsideGeometryOptions("Leland Avenue", polygon)
.setTop(5));
// complete
client.searchInsideGeometryWithResponse(
new SearchInsideGeometryOptions("Leland Avenue", polygon)
.setTop(5),
null).getStatusCode();
Search Along Route
System.out.println("Search Along Route");
// create route points
List<GeoPosition> points = new ArrayList<>();
points.add(new GeoPosition(-122.143035, 47.653536));
points.add(new GeoPosition(-122.187164, 47.617556));
points.add(new GeoPosition(-122.114981, 47.570599));
points.add(new GeoPosition(-122.132756, 47.654009));
GeoLineString route = new GeoLineString(points);
// simple
client.searchAlongRoute(new SearchAlongRouteOptions("burger", 1000, route));
// options
client.searchAlongRoute(
new SearchAlongRouteOptions("burger", 1000, route)
.setCategoryFilter(Arrays.asList(7315))
.setTop(5));
// complete
client.searchAlongRouteWithResponse(
new SearchAlongRouteOptions("burger", 1000, route)
.setCategoryFilter(Arrays.asList(7315))
.setTop(5),
null).getStatusCode();
Begin Fuzzy Search Batch
List<FuzzySearchOptions> fuzzyOptionsList = new ArrayList<>();
fuzzyOptionsList.add(new FuzzySearchOptions("atm", new GeoPosition(-122.128362, 47.639769))
.setRadiusInMeters(5000).setTop(5));
fuzzyOptionsList.add(new FuzzySearchOptions("Statue of Liberty").setTop(2));
fuzzyOptionsList.add(new FuzzySearchOptions("Starbucks", new GeoPosition(-122.128362, 47.639769))
.setRadiusInMeters(5000));
System.out.println("Post Search Fuzzy Batch Async");
client.beginFuzzySearchBatch(fuzzyOptionsList).getFinalResult();
Begin Search Address Batch
List<SearchAddressOptions> optionsList = new ArrayList<>();
optionsList.add(new SearchAddressOptions("400 Broad St, Seattle, WA 98109").setTop(3));
optionsList.add(new SearchAddressOptions("One, Microsoft Way, Redmond, WA 98052").setTop(3));
optionsList.add(new SearchAddressOptions("350 5th Ave, New York, NY 10118").setTop(3));
optionsList.add(new SearchAddressOptions("1 Main Street")
.setCountryFilter(Arrays.asList("GB", "US", "AU")).setTop(3));
// Search address batch async -
// /rest/api/maps/search/post-search-address-batch
// This call posts addresses for search using the Asynchronous Batch API.
// SyncPoller will do the polling automatically and you can retrieve the result
// with getFinalResult()
System.out.println("Search Address Batch Async");
client.beginSearchAddressBatch(optionsList).getFinalResult();
SyncPoller<BatchSearchResult, BatchSearchResult> poller = client.beginSearchAddressBatch(optionsList);
BatchSearchResult result = poller.getFinalResult();
Reverse Reverse Search Address Batch
List<ReverseSearchAddressOptions> reverseOptionsList = new ArrayList<>();
reverseOptionsList.add(new ReverseSearchAddressOptions(new GeoPosition(2.294911, 48.858561)));
reverseOptionsList.add(
new ReverseSearchAddressOptions(new GeoPosition(-122.127896, 47.639765))
.setRadiusInMeters(5000)
);
reverseOptionsList.add(new ReverseSearchAddressOptions(new GeoPosition(-122.348170, 47.621028)));
System.out.println("Reverse Search Address Batch Async");
BatchReverseSearchResult br1 =
client.beginReverseSearchAddressBatch(reverseOptionsList).getFinalResult();
Troubleshooting
When you interact with the Azure Maps Services, errors returned by the Maps service correspond to the same HTTP status codes returned for REST API requests.
For example, if you search with an invalid coordinate, a error is returned, indicating "Bad Request".400
Next steps
Several Azure Maps Search Java SDK samples are available to you in the SDK's GitHub repository. Azure Maps Search Samples
Contributing
For details on contributing to this repository, see the contributing guide.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for