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.search.MapsSearchClientBuilder
-
Adds a custom Http pipeline policy.
- ADMIN_DISTRICT - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
First administrative level within the country/region level, such as a state or a province.
- ADMIN_DISTRICT2 - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
Second administrative level within the country/region level, such as a county.
- Authentication - Search tag in Overview
- Section
- Azure Maps SDK Search client library for Java - Search tag in Overview
- Section
B
- BaseSearchOptions - Class in com.azure.maps.search.models
-
Class holding optional parameters for Search.
- BaseSearchOptions() - Constructor for class com.azure.maps.search.models.BaseSearchOptions
-
Creates a new instance of
BaseSearchOptions. - Boundary - Class in com.azure.maps.search.models
-
`GeoJSON GeocodingFeature` object that describe the boundaries of a geographical area.
- Boundary() - Constructor for class com.azure.maps.search.models.Boundary
-
Creates an instance of Boundary class.
- BoundaryResultTypeEnum - Class in com.azure.maps.search.models
-
Defines values for BoundaryResultTypeEnum.
- BoundaryResultTypeEnum() - Constructor for class com.azure.maps.search.models.BoundaryResultTypeEnum
-
Deprecated.
- buildAsyncClient() - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Builds an instance of SearchAsyncClient async client.
- buildClient() - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Builds an instance of SearchClient sync client.
C
- clientOptions(ClientOptions) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The client options such as application ID and custom headers to set on a request.
- com.azure.maps.search - package com.azure.maps.search
-
Package containing the classes for SearchClient.
- com.azure.maps.search.models - package com.azure.maps.search.models
-
Package containing the data models for SearchClient.
- configuration(Configuration) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The configuration store that is used during construction of the service client.
- Contributing - Search tag in Overview
- Section
- COUNTRY_REGION - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
Country or region.
- credential(AzureKeyCredential) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets the
AzureKeyCredentialused to authenticate HTTP requests. - credential(AzureSasCredential) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets the
AzureSasCredentialused to authenticate HTTP requests. - credential(TokenCredential) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets the
TokenCredentialused to authenticate HTTP requests.
D
- Documentation - Search tag in Overview
- Section
E
- endpoint(String) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Set endpoint of the service.
- Examples - Search tag in Overview
- Section
F
- FEATURE_COLLECTION - Static variable in class com.azure.maps.search.models.FeatureCollectionEnum
-
Static value FeatureCollection for FeatureCollectionEnum.
- FeatureCollectionEnum - Class in com.azure.maps.search.models
-
The type of a FeatureCollection object must be FeatureCollection.
- FeatureCollectionEnum() - Constructor for class com.azure.maps.search.models.FeatureCollectionEnum
-
Deprecated.Use the
FeatureCollectionEnum.fromString(String)factory method. - fromJson(JsonReader) - Static method in class com.azure.maps.search.models.Boundary
-
Reads an instance of Boundary from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeocodingBatchRequestBody
-
Reads an instance of GeocodingBatchRequestBody from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Reads an instance of GeocodingBatchResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Reads an instance of GeocodingBatchResponseSummary from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeocodingResponse
-
Reads an instance of GeocodingResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeoJsonFeature
-
Reads an instance of GeoJsonFeature from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeoJsonGeometry
-
Reads an instance of GeoJsonGeometry from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.GeoJsonObject
-
Reads an instance of GeoJsonObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.Intersection
-
Reads an instance of Intersection from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.MapsSearchAddress
-
Reads an instance of MapsSearchAddress from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Reads an instance of MapsSearchAddressCountryRegion from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.maps.search.models.ReverseGeocodingBatchRequestBody
-
Reads an instance of ReverseGeocodingBatchRequestBody from the JsonReader.
- fromString(String) - Static method in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
Creates or finds a BoundaryResultTypeEnum from its string representation.
- fromString(String) - Static method in class com.azure.maps.search.models.FeatureCollectionEnum
-
Creates or finds a FeatureCollectionEnum from its string representation.
- fromString(String) - Static method in enum com.azure.maps.search.models.GeoJsonObjectType
-
Parses a serialized value to a GeoJsonObjectType instance.
- fromString(String) - Static method in class com.azure.maps.search.models.ResolutionEnum
-
Creates or finds a ResolutionEnum from its string representation.
G
- GEO_JSON_FEATURE - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON Feature` object.
- GEO_JSON_FEATURE_COLLECTION - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON FeatureCollection` object.
- GEO_JSON_GEOMETRY_COLLECTION - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON GeometryCollection` geometry.
- GEO_JSON_LINE_STRING - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON LineString` geometry.
- GEO_JSON_MULTI_LINE_STRING - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON MultiLineString` geometry.
- GEO_JSON_MULTI_POINT - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON MultiPoint` geometry.
- GEO_JSON_MULTI_POLYGON - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON MultiPolygon` geometry.
- GEO_JSON_POINT - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON Point` geometry.
- GEO_JSON_POLYGON - Enum constant in enum com.azure.maps.search.models.GeoJsonObjectType
-
`GeoJSON Polygon` geometry.
- GeocodingBatchRequestBody - Class in com.azure.maps.search.models
-
The list of address geocoding queries/requests to process.
- GeocodingBatchRequestBody() - Constructor for class com.azure.maps.search.models.GeocodingBatchRequestBody
-
Creates an instance of GeocodingBatchRequestBody class.
- GeocodingBatchResponse - Class in com.azure.maps.search.models
-
This object is returned from a successful Geocoding Batch service call.
- GeocodingBatchResponse() - Constructor for class com.azure.maps.search.models.GeocodingBatchResponse
-
Creates an instance of GeocodingBatchResponse class.
- GeocodingBatchResponseSummary - Class in com.azure.maps.search.models
-
Summary for the batch request.
- GeocodingBatchResponseSummary() - Constructor for class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Creates an instance of GeocodingBatchResponseSummary class.
- GeocodingResponse - Class in com.azure.maps.search.models
-
This object is returned from a successful Geocoding call.
- GeocodingResponse() - Constructor for class com.azure.maps.search.models.GeocodingResponse
-
Creates an instance of GeocodingResponse class.
- GeoJsonFeature - Class in com.azure.maps.search.models
-
A valid `GeoJSON Feature` object type.
- GeoJsonFeature() - Constructor for class com.azure.maps.search.models.GeoJsonFeature
-
Creates an instance of GeoJsonFeature class.
- GeoJsonGeometry - Class in com.azure.maps.search.models
-
A valid `GeoJSON` geometry object.
- GeoJsonGeometry() - Constructor for class com.azure.maps.search.models.GeoJsonGeometry
-
Creates an instance of GeoJsonGeometry class.
- GeoJsonObject - Class in com.azure.maps.search.models
-
A valid `GeoJSON` object.
- GeoJsonObject() - Constructor for class com.azure.maps.search.models.GeoJsonObject
-
Creates an instance of GeoJsonObject class.
- GeoJsonObjectType - Enum in com.azure.maps.search.models
-
Specifies the `GeoJSON` type.
- getAddressLine() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the address line associated with the search options.
- getAddressLine() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the addressLine property: AddressLine that includes Street Name and Number.
- getAdminDistrict() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the first-level administrative district (e.g., a state or province) for the search options.
- getAdminDistrict2() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the secondary administrative district for the search options.
- getAdminDistrict3() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the third-level administrative district for the search query.
- getAdminDistricts() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the adminDistricts property: The subdivision name in the country or region for an address.
- getBaseStreet() - Method in class com.azure.maps.search.models.Intersection
-
Get the baseStreet property: Primary street for the location.
- getBatchItems() - Method in class com.azure.maps.search.models.GeocodingBatchRequestBody
-
Get the batchItems property: The list of queries to process.
- getBatchItems() - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Get the batchItems property: Array containing the batch results.
- getBatchItems() - Method in class com.azure.maps.search.models.ReverseGeocodingBatchRequestBody
-
Get the batchItems property: The list of queries to process.
- getBbox() - Method in class com.azure.maps.search.models.GeoJsonObject
-
Get the bbox property: Bounding box.
- getBoundingBox() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the geographical bounding box defined for the search.
- getCoordinates() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the geographic coordinates (latitude and longitude) used for location-based search relevance.
- getCopyright() - Method in class com.azure.maps.search.models.Boundary
-
Get the copyright property: The copyright string.
- getCopyrightUrl() - Method in class com.azure.maps.search.models.Boundary
-
Get the copyrightURL property: A URL that lists many of the data providers for Azure Maps and their related copyright information.
- getCountryRegion() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the country or region code used to filter search results.
- getCountryRegion() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the countryRegion property: The countryRegion property.
- getDisplayName() - Method in class com.azure.maps.search.models.Intersection
-
Get the displayName property: Complete name of the intersection.
- getFeatures() - Method in class com.azure.maps.search.models.GeocodingResponse
-
Get the features property: The features property.
- getFeatureType() - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Get the featureType property: The type of the feature.
- getFormattedAddress() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the formattedAddress property: Formatted Address property.
- getGeocoding(BaseSearchOptions) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- getGeocoding(BaseSearchOptions) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- Get Geocoding - Search tag in Overview
- Section
- getGeocodingBatch(GeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.
- getGeocodingBatch(GeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.
- Get Geocoding Batch - Search tag in Overview
- Section
- getGeocodingBatchWithResponse(GeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.
- getGeocodingBatchWithResponse(GeocodingBatchRequestBody, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.
- getGeocodingNoCustomHeaderWithResponse(BaseSearchOptions) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- getGeocodingNoCustomHeaderWithResponse(BaseSearchOptions, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- getGeocodingWithBaseResponse(BaseSearchOptions) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- getGeocodingWithBaseResponse(BaseSearchOptions, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get longitude and latitude coordinates of a street address or name of a place.
- getGeometriesCopyright() - Method in class com.azure.maps.search.models.Boundary
-
Get the geometriesCopyright property: A collection of copyright information for each geometry of the Boundary object in the same order they appear.
- getGeometry() - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Get the geometry property: A valid `GeoJSON` geometry object.
- getId() - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Get the id property: Identifier for the feature.
- getIntersection() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the intersection property: The address of the result.
- getIntersectionType() - Method in class com.azure.maps.search.models.Intersection
-
Get the intersectionType property: Type of intersection.
- getISO() - Method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Get the iSO property: ISO of country/region.
- getLatest() - Static method in enum com.azure.maps.search.MapsSearchServiceVersion
-
Gets the latest service version supported by this client library
- getLocality() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the locality or city specified in the search options.
- getLocality() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the locality property: locality property.
- getName() - Method in class com.azure.maps.search.models.Boundary
-
Get the name property: The name associated with the geographical area.
- getName() - Method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Get the name property: name of country/region.
- getNeighborhood() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the neighborhood property: neighborhood property.
- getNextLink() - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Get the nextLink property: The is the link to the next page of the features returned.
- getNextLink() - Method in class com.azure.maps.search.models.GeocodingResponse
-
Get the nextLink property: The is the link to the next page of the features returned.
- getPolygons(GeoPosition, String, BoundaryResultTypeEnum, ResolutionEnum) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get polygon data of a geographical area shape such as a city or a country region.
- getPolygons(GeoPosition, String, BoundaryResultTypeEnum, ResolutionEnum) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get polygon data of a geographical area shape such as a city or a country region.
- Get Polygons - Search tag in Overview
- Section
- getPolygonsWithResponse(GeoPosition, String, BoundaryResultTypeEnum, ResolutionEnum, Context) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get polygon data of a geographical area shape such as a city or a country region.
- getPolygonsWithResponse(GeoPosition, String, BoundaryResultTypeEnum, ResolutionEnum, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get polygon data of a geographical area shape such as a city or a country region.
- getPostalCode() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the postal code used in the search query.
- getPostalCode() - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Get the postalCode property: Postal Code property.
- getProperties() - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Get the properties property: Properties can contain any additional metadata about the `Feature`.
- getQuery() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the query string representing a location, such as an address or landmark.
- getReverseGeocoding(GeoPosition, List<ReverseGeocodingResultTypeEnum>, String) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get a street address and location info from longitude and latitude coordinates.
- getReverseGeocoding(GeoPosition, List<ReverseGeocodingResultTypeEnum>, String) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get a street address and location info from longitude and latitude coordinates.
- Get Reverse Geocoding - Search tag in Overview
- Section
- getReverseGeocodingBatch(ReverseGeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.
- getReverseGeocodingBatch(ReverseGeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.
- Get Reverse Geocoding Batch - Search tag in Overview
- Section
- getReverseGeocodingBatchWithResponse(ReverseGeocodingBatchRequestBody) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.
- getReverseGeocodingBatchWithResponse(ReverseGeocodingBatchRequestBody, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.
- getReverseGeocodingWithResponse(GeoPosition, List<ReverseGeocodingResultTypeEnum>, String) - Method in class com.azure.maps.search.MapsSearchAsyncClient
-
Use to get a street address and location info from longitude and latitude coordinates.
- getReverseGeocodingWithResponse(GeoPosition, List<ReverseGeocodingResultTypeEnum>, String, Context) - Method in class com.azure.maps.search.MapsSearchClient
-
Use to get a street address and location info from longitude and latitude coordinates.
- getSecondaryStreet1() - Method in class com.azure.maps.search.models.Intersection
-
Get the secondaryStreet1 property: The first intersecting street.
- getSecondaryStreet2() - Method in class com.azure.maps.search.models.Intersection
-
Get the secondaryStreet2 property: If any, the second intersecting street.
- getSuccessfulRequests() - Method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Get the successfulRequests property: Number of successful requests in the batch.
- getSummary() - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Get the summary property: Summary for the batch request.
- Getting started - Search tag in Overview
- Section
- getTop() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the maximum number of search responses allowed.
- getTotalRequests() - Method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Get the totalRequests property: Total number of requests in the batch.
- getType() - Method in class com.azure.maps.search.models.Boundary
-
Get the type property: Specifies the `GeoJSON` type.
- getType() - Method in class com.azure.maps.search.models.GeocodingResponse
-
Get the type property: The type of a FeatureCollection object must be FeatureCollection.
- getType() - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Get the type property: Specifies the `GeoJSON` type.
- getType() - Method in class com.azure.maps.search.models.GeoJsonGeometry
-
Get the type property: Specifies the `GeoJSON` type.
- getType() - Method in class com.azure.maps.search.models.GeoJsonObject
-
Get the type property: Specifies the `GeoJSON` type.
- getVersion() - Method in enum com.azure.maps.search.MapsSearchServiceVersion
- getView() - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Retrieves the region-specific view parameter that affects geopolitical labeling.
H
- httpClient(HttpClient) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The HTTP client used to send the request.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The logging configuration for HTTP requests and responses.
- HUGE - Static variable in class com.azure.maps.search.models.ResolutionEnum
-
Return the boundary geometry with more or the same amount of points as large.
I
- Include the recommended packages - Search tag in Overview
- Section
- Intersection - Class in com.azure.maps.search.models
-
The address of the result.
- Intersection() - Constructor for class com.azure.maps.search.models.Intersection
-
Creates an instance of Intersection class.
K
- Key concepts - Search tag in Overview
- Section
L
- LARGE - Static variable in class com.azure.maps.search.models.ResolutionEnum
-
Return the boundary geometry with more or the same amount of points as medium.
- LOCALITY - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
A concentrated area of human settlement, such as a city, town or village.
M
- mapsClientId(String) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets the Azure Maps client id for use with Azure AD Authentication.
- MapsSearchAddress - Class in com.azure.maps.search.models
-
The address of the result.
- MapsSearchAddress() - Constructor for class com.azure.maps.search.models.MapsSearchAddress
-
Creates an instance of MapsSearchAddress class.
- MapsSearchAddressCountryRegion - Class in com.azure.maps.search.models
-
The MapsSearchAddressCountryRegion model.
- MapsSearchAddressCountryRegion() - Constructor for class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Creates an instance of MapsSearchAddressCountryRegion class.
- MapsSearchAsyncClient - Class in com.azure.maps.search
-
Initializes a new instance of the asynchronous SearchClient type.
- MapsSearchClient - Class in com.azure.maps.search
-
MapsSearchClientinstances are created via theMapsSearchClientBuilder, as shown below. - MapsSearchClientBuilder - Class in com.azure.maps.search
-
Builder class used to instantiate both synchronous and asynchronous
MapsSearchClientclients. - MapsSearchClientBuilder() - Constructor for class com.azure.maps.search.MapsSearchClientBuilder
-
Default constructor for the builder class.
- MapsSearchServiceVersion - Enum in com.azure.maps.search
-
Contains the versions of the Search Service available for the clients.
- MEDIUM - Static variable in class com.azure.maps.search.models.ResolutionEnum
-
Return the boundary geometry with more or the same amount of points as small.
N
- NEIGHBORHOOD - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
A section of a populated place that is typically well-known, but often with indistinct boundaries.
- Next steps - Search tag in Overview
- Section
P
- pipeline(HttpPipeline) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The HTTP pipeline to send requests through.
- POSTAL_CODE - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
The smallest post code category, such as a zip code.
- POSTAL_CODE2 - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
The next largest post code category after postalCode that is created by aggregating postalCode areas.
- POSTAL_CODE3 - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
The next largest post code category after postalCode2 that is created by aggregating postalCode2 areas.
- POSTAL_CODE4 - Static variable in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
The next largest post code category after postalCode3 that is created by aggregating postalCode3 areas.
- Prerequisites - Search tag in Overview
- Section
R
- ResolutionEnum - Class in com.azure.maps.search.models
-
Defines values for ResolutionEnum.
- ResolutionEnum() - Constructor for class com.azure.maps.search.models.ResolutionEnum
-
Deprecated.Use the
ResolutionEnum.fromString(String)factory method. - retryOptions(RetryOptions) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets retry options
- retryPolicy(RetryPolicy) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- ReverseGeocodingBatchRequestBody - Class in com.azure.maps.search.models
-
The list of reverse geocoding queries/requests to process.
- ReverseGeocodingBatchRequestBody() - Constructor for class com.azure.maps.search.models.ReverseGeocodingBatchRequestBody
-
Creates an instance of ReverseGeocodingBatchRequestBody class.
S
- serviceVersion(MapsSearchServiceVersion) - Method in class com.azure.maps.search.MapsSearchClientBuilder
-
Sets the
MapsSearchServiceVersionthat is used when making API requests. - setAddressLine(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the street address line for a more specific location in the search query.
- setAddressLine(String) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the addressLine property: AddressLine that includes Street Name and Number.
- setAdminDistrict(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the first-level administrative district to refine the search query.
- setAdminDistrict2(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the secondary administrative district to refine the search query.
- setAdminDistrict3(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the third-level administrative district to refine the search.
- setAdminDistricts(List<MapsSearchAddressAdminDistrictsItem>) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the adminDistricts property: The subdivision name in the country or region for an address.
- setBaseStreet(String) - Method in class com.azure.maps.search.models.Intersection
-
Set the baseStreet property: Primary street for the location.
- setBatchItems(List<GeocodingBatchRequestItem>) - Method in class com.azure.maps.search.models.GeocodingBatchRequestBody
-
Set the batchItems property: The list of queries to process.
- setBatchItems(List<GeocodingBatchResponseItem>) - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Set the batchItems property: Array containing the batch results.
- setBatchItems(List<ReverseGeocodingBatchRequestItem>) - Method in class com.azure.maps.search.models.ReverseGeocodingBatchRequestBody
-
Set the batchItems property: The list of queries to process.
- setBbox(GeoBoundingBox) - Method in class com.azure.maps.search.models.Boundary
-
/** Sets the bounding box of this feature using a
GeoBoundingBox. - setBbox(List<Double>) - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Set the bbox property: Bounding box.
- setBbox(List<Double>) - Method in class com.azure.maps.search.models.GeoJsonGeometry
-
Set the bbox property: Bounding box.
- setBbox(List<Double>) - Method in class com.azure.maps.search.models.GeoJsonObject
-
Set the bbox property: Bounding box.
- setBoundingBox(GeoBoundingBox) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets a rectangular geographical area for focusing the search within defined boundaries.
- setCoordinates(GeoPosition) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the geographic coordinates to enhance the relevance of search results based on location.
- setCopyright(String) - Method in class com.azure.maps.search.models.Boundary
-
Set the copyright property: The copyright string.
- setCopyrightUrl(String) - Method in class com.azure.maps.search.models.Boundary
-
Set the copyrightURL property: A URL that lists many of the data providers for Azure Maps and their related copyright information.
- setCountryRegion(MapsSearchAddressCountryRegion) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the countryRegion property: The countryRegion property.
- setCountryRegion(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the country or region code to narrow down the search results.
- setDisplayName(String) - Method in class com.azure.maps.search.models.Intersection
-
Set the displayName property: Complete name of the intersection.
- setFeatures(List<FeaturesItem>) - Method in class com.azure.maps.search.models.GeocodingResponse
-
Set the features property: The features property.
- setFeatureType(String) - Method in class com.azure.maps.search.models.Boundary
-
Set the featureType property: The type of the feature.
- setFeatureType(String) - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Set the featureType property: The type of the feature.
- setFormattedAddress(String) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the formattedAddress property: Formatted Address property.
- setGeometriesCopyright(List<GeometryCopyright>) - Method in class com.azure.maps.search.models.Boundary
-
Set the geometriesCopyright property: A collection of copyright information for each geometry of the Boundary object in the same order they appear.
- setGeometry(GeoJsonGeometry) - Method in class com.azure.maps.search.models.Boundary
-
Set the geometry property: A valid `GeoJSON` geometry object.
- setGeometry(GeoJsonGeometry) - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Set the geometry property: A valid `GeoJSON` geometry object.
- setId(String) - Method in class com.azure.maps.search.models.Boundary
-
Set the id property: Identifier for the feature.
- setId(String) - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Set the id property: Identifier for the feature.
- setIntersection(Intersection) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the intersection property: The address of the result.
- setIntersectionType(String) - Method in class com.azure.maps.search.models.Intersection
-
Set the intersectionType property: Type of intersection.
- setISO(String) - Method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Set the iSO property: ISO of country/region.
- setLocality(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the locality or city to narrow the search results to a specific area.
- setLocality(String) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the locality property: locality property.
- setName(String) - Method in class com.azure.maps.search.models.Boundary
-
Set the name property: The name associated with the geographical area.
- setName(String) - Method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
-
Set the name property: name of country/region.
- setNeighborhood(String) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the neighborhood property: neighborhood property.
- setNextLink(String) - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Set the nextLink property: The is the link to the next page of the features returned.
- setNextLink(String) - Method in class com.azure.maps.search.models.GeocodingResponse
-
Set the nextLink property: The is the link to the next page of the features returned.
- setPostalCode(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the postal code for a more targeted search result.
- setPostalCode(String) - Method in class com.azure.maps.search.models.MapsSearchAddress
-
Set the postalCode property: Postal Code property.
- setProperties(Object) - Method in class com.azure.maps.search.models.Boundary
-
Set the properties property: Properties can contain any additional metadata about the `Feature`.
- setProperties(Object) - Method in class com.azure.maps.search.models.GeoJsonFeature
-
Set the properties property: Properties can contain any additional metadata about the `Feature`.
- setQuery(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the query string used to specify a location for the search request.
- setSecondaryStreet1(String) - Method in class com.azure.maps.search.models.Intersection
-
Set the secondaryStreet1 property: The first intersecting street.
- setSecondaryStreet2(String) - Method in class com.azure.maps.search.models.Intersection
-
Set the secondaryStreet2 property: If any, the second intersecting street.
- setSuccessfulRequests(Integer) - Method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Set the successfulRequests property: Number of successful requests in the batch.
- setSummary(GeocodingBatchResponseSummary) - Method in class com.azure.maps.search.models.GeocodingBatchResponse
-
Set the summary property: Summary for the batch request.
- setTop(Integer) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the maximum number of responses that will be returned for a search query, enabling control over the response size.
- setTotalRequests(Integer) - Method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
-
Set the totalRequests property: Total number of requests in the batch.
- setType(FeatureCollectionEnum) - Method in class com.azure.maps.search.models.GeocodingResponse
-
Set the type property: The type of a FeatureCollection object must be FeatureCollection.
- setView(String) - Method in class com.azure.maps.search.models.BaseSearchOptions
-
Sets the view parameter to align geopolitical borders and labels with a specific region.
- SMALL - Static variable in class com.azure.maps.search.models.ResolutionEnum
-
Return the boundary geometry with the least amount of points.
T
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.Boundary
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeocodingBatchRequestBody
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeocodingBatchResponse
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeocodingBatchResponseSummary
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeocodingResponse
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeoJsonFeature
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeoJsonGeometry
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.GeoJsonObject
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.Intersection
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.MapsSearchAddress
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.MapsSearchAddressCountryRegion
- toJson(JsonWriter) - Method in class com.azure.maps.search.models.ReverseGeocodingBatchRequestBody
- toString() - Method in enum com.azure.maps.search.models.GeoJsonObjectType
- Troubleshooting - Search tag in Overview
- Section
V
- V2023_06_01 - Enum constant in enum com.azure.maps.search.MapsSearchServiceVersion
-
Service version
2.0. - valueOf(String) - Static method in enum com.azure.maps.search.MapsSearchServiceVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.maps.search.models.GeoJsonObjectType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.maps.search.MapsSearchServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.maps.search.models.BoundaryResultTypeEnum
-
Gets known BoundaryResultTypeEnum values.
- values() - Static method in class com.azure.maps.search.models.FeatureCollectionEnum
-
Gets known FeatureCollectionEnum values.
- values() - Static method in enum com.azure.maps.search.models.GeoJsonObjectType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.maps.search.models.ResolutionEnum
-
Gets known ResolutionEnum values.
All Classes and Interfaces|All Packages
BoundaryResultTypeEnum.fromString(String)factory method.