Package com.azure.maps.render
Class MapsRenderClient
java.lang.Object
com.azure.maps.render.MapsRenderClient
Initializes a new instance of the synchronous RenderClient type.
MapsRenderClient
instances are created via the MapsRenderClientBuilder
, as shown below.
Creating a sync client using a AzureKeyCredential
:
// Authenticates using subscription key AzureKeyCredential keyCredential = new AzureKeyCredential(System.getenv("SUBSCRIPTION_KEY")); // Creates a builder MapsRenderClientBuilder builder = new MapsRenderClientBuilder(); builder.credential(keyCredential); builder.httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS)); // Builds the client MapsRenderClient client = builder.buildClient();
-
Method Summary
Modifier and TypeMethodDescriptionvoid
downloadMapStateTile
(OutputStream stream, String statesetId, TileIndex tileIndex) Download Map State Tile Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK.com.azure.core.http.rest.Response<Void>
downloadMapStateTileWithResponse
(OutputStream stream, String statesetId, TileIndex tileIndex, com.azure.core.util.Context context) Download Map State TileGet Copyright Caption Copyrights API is designed to serve copyright information for Render Tile service.com.azure.core.http.rest.Response<CopyrightCaption>
getCopyrightCaptionWithResponse
(com.azure.core.util.Context context) Get Copyright Caption Copyrights API is designed to serve copyright information for Render Tile service.getCopyrightForTile
(TileIndex tileIndex, boolean includeText) Get Copyright For Tile **Applies to**: S0 and S1 pricing tiers.com.azure.core.http.rest.Response<Copyright>
getCopyrightForTileWithResponse
(TileIndex tileIndex, boolean includeText, com.azure.core.util.Context context) Get Copyright For Tile Copyrights With Response API is designed to serve copyright information for Render Tile service with response.getCopyrightForWorld
(boolean includeText) Get Copyright For World **Applies to**: S0 and S1 pricing tiers.com.azure.core.http.rest.Response<Copyright>
getCopyrightForWorldWithResponse
(boolean includeText, com.azure.core.util.Context context) Get Copyright For World Copyrights with response API is designed to serve copyright information with response for Render Tile service.getCopyrightFromBoundingBox
(com.azure.core.models.GeoBoundingBox boundingBox, boolean includeText) Get Copyright From Bounding Box **Applies to**: S0 and S1 pricing tiers.com.azure.core.http.rest.Response<Copyright>
getCopyrightFromBoundingBoxWithResponse
(com.azure.core.models.GeoBoundingBox boundingBox, boolean includeText, com.azure.core.util.Context context) Get Copyright From Bounding Box Returns copyright information for a given bounding box with response.getMapAttribution
(TilesetId tilesetId, int zoom, com.azure.core.models.GeoBoundingBox bounds) Get Map Attributioncom.azure.core.http.rest.Response<MapAttribution>
getMapAttributionWithResponse
(TilesetId tilesetId, int zoom, com.azure.core.models.GeoBoundingBox bounds, com.azure.core.util.Context context) Get Map Attribution The Get Map Attribution With Response API allows users to request map copyright attribution information for a section of a tileset with responsecom.azure.core.util.BinaryData
getMapStaticImage
(MapStaticImageOptions options) Get Map Static Image The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getMapStaticImageWithResponse
(MapStaticImageOptions options, com.azure.core.util.Context context) Get Map Static Image The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20.com.azure.core.util.BinaryData
getMapTile
(MapTileOptions options) Get Map TilegetMapTileset
(TilesetId tilesetId) Get Map Tilesetcom.azure.core.http.rest.Response<MapTileset>
getMapTilesetWithResponse
(TilesetId tilesetId, com.azure.core.util.Context context) Get Map Tileset The Get Map Tileset API allows users to request metadata for a tileset.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getMapTileWithResponse
(MapTileOptions options, com.azure.core.util.Context context) Get Map Tile
-
Method Details
-
getMapTile
Get Map TileSystem.out.println("Get Map Tile"); MapTileOptions mapTileOptions = new MapTileOptions(); mapTileOptions.setTilesetId(TilesetId.MICROSOFT_BASE_ROAD); mapTileOptions.setTileIndex(new TileIndex().setX(10).setY(22).setZ(6)); client.getMapTile(mapTileOptions);
The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK.- Parameters:
options
- theMapTileOptions
to control the API behavior.- Returns:
- BinaryData
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapTileWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getMapTileWithResponse(MapTileOptions options, com.azure.core.util.Context context) Get Map TileSystem.out.println("Get Map Tile"); MapTileOptions mapTileOptions = new MapTileOptions(); mapTileOptions.setTilesetId(TilesetId.MICROSOFT_BASE_ROAD); mapTileOptions.setTileIndex(new TileIndex().setX(10).setY(22).setZ(6)); client.getMapTile(mapTileOptions);
The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK.- Parameters:
options
- theMapTileOptions
to control the API behavior.context
- the context associated with this operation.- Returns:
- the response.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapTileset
Get Map TilesetSystem.out.println("Get Map Tileset"); new TilesetId(); client.getMapTileset(TilesetId.MICROSOFT_BASE);
The Get Map Tileset API allows users to request metadata for a tileset.- Parameters:
tilesetId
- the tileset id.- Returns:
- metadata for a tileset in the TileJSON format.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapTilesetWithResponse
public com.azure.core.http.rest.Response<MapTileset> getMapTilesetWithResponse(TilesetId tilesetId, com.azure.core.util.Context context) Get Map Tileset The Get Map Tileset API allows users to request metadata for a tileset.System.out.println("Get Map Tileset"); new TilesetId(); client.getMapTileset(TilesetId.MICROSOFT_BASE);
- Parameters:
tilesetId
- the tileset id.context
- the context associated with this operation.- Returns:
- metadata for a tileset in the TileJSON format.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapAttribution
public MapAttribution getMapAttribution(TilesetId tilesetId, int zoom, com.azure.core.models.GeoBoundingBox bounds) Get Map AttributionSystem.out.println("Get Map Attribution"); GeoBoundingBox bounds = new GeoBoundingBox(-122.414162, 47.57949, -122.247157, 47.668372); new TilesetId(); client.getMapAttribution(TilesetId.MICROSOFT_BASE, 6, bounds);
- Parameters:
tilesetId
- the tileset id.zoom
- Zoom level for the desired map attribution.bounds
- theGeoBoundingBox
surrounding the area for which attribution is needed.- Returns:
- copyright attribution for the requested section of a tileset.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapAttributionWithResponse
public com.azure.core.http.rest.Response<MapAttribution> getMapAttributionWithResponse(TilesetId tilesetId, int zoom, com.azure.core.models.GeoBoundingBox bounds, com.azure.core.util.Context context) Get Map Attribution The Get Map Attribution With Response API allows users to request map copyright attribution information for a section of a tileset with responseSystem.out.println("Get Map Attribution"); GeoBoundingBox bounds = new GeoBoundingBox(-122.414162, 47.57949, -122.247157, 47.668372); new TilesetId(); client.getMapAttribution(TilesetId.MICROSOFT_BASE, 6, bounds);
- Parameters:
tilesetId
- the tileset id.zoom
- Zoom level for the desired map attribution.bounds
- theGeoBoundingBox
surrounding the area for which attribution is needed.context
- the context associated with this operation.- Returns:
- copyright attribution for the requested section of a tileset.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
downloadMapStateTile
Download Map State Tile Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid)).- Parameters:
stream
- The output stream to which the tile is written to.statesetId
- The stateset id.tileIndex
- Parameter group.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
downloadMapStateTileWithResponse
public com.azure.core.http.rest.Response<Void> downloadMapStateTileWithResponse(OutputStream stream, String statesetId, TileIndex tileIndex, com.azure.core.util.Context context) Download Map State Tile- Parameters:
stream
- The output stream to which the tile is written to.statesetId
- The stateset idtileIndex
- Parameter groupcontext
- the context associated with this operation- Returns:
- the map tile
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightCaption
Get Copyright Caption Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. As an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map.System.out.println("Get Copyright Caption"); client.getCopyrightCaption();
- Returns:
- this object is returned from a successful copyright call.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightCaptionWithResponse
public com.azure.core.http.rest.Response<CopyrightCaption> getCopyrightCaptionWithResponse(com.azure.core.util.Context context) Get Copyright Caption Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. As an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map.System.out.println("Get Copyright Caption"); client.getCopyrightCaption();
- Parameters:
context
- the context associated with this operation- Returns:
- this object is returned from a successful copyright call.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapStaticImage
Get Map Static Image The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice.System.out.println("Get Map Static Image"); GeoBoundingBox bbox = new GeoBoundingBox(1.355233, 42.982261, 24.980233, 56.526017); new StaticMapLayer(); new RasterTileFormat(); MapStaticImageOptions mapStaticImageOptions = new MapStaticImageOptions().setStaticMapLayer(StaticMapLayer.BASIC) .setMapImageStyle(MapImageStyle.MAIN).setZoom(2) .setBoundingBox(bbox).setRasterTileFormat(RasterTileFormat.PNG); client.getMapStaticImage(mapStaticImageOptions).toStream();
- Parameters:
options
- theMapStaticImageOptions
used in the call.- Returns:
- BinaryData
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getMapStaticImageWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getMapStaticImageWithResponse(MapStaticImageOptions options, com.azure.core.util.Context context) Get Map Static Image The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice.System.out.println("Get Map Static Image"); GeoBoundingBox bbox = new GeoBoundingBox(1.355233, 42.982261, 24.980233, 56.526017); new StaticMapLayer(); new RasterTileFormat(); MapStaticImageOptions mapStaticImageOptions = new MapStaticImageOptions().setStaticMapLayer(StaticMapLayer.BASIC) .setMapImageStyle(MapImageStyle.MAIN).setZoom(2) .setBoundingBox(bbox).setRasterTileFormat(RasterTileFormat.PNG); client.getMapStaticImage(mapStaticImageOptions).toStream();
- Parameters:
options
- theMapStaticImageOptions
used in the call.context
- the context associated with this operation.- Returns:
- the response.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightFromBoundingBox
public Copyright getCopyrightFromBoundingBox(com.azure.core.models.GeoBoundingBox boundingBox, boolean includeText) Get Copyright From Bounding Box **Applies to**: S0 and S1 pricing tiers. Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates.GeoBoundingBox boundingBox = new GeoBoundingBox(52.41064, 4.84228, 52.41072, 4.84239); client.getCopyrightFromBoundingBox(boundingBox, true);
- Parameters:
boundingBox
- theGeoBoundingBox
for which copyright information is needed.includeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.- Returns:
- this object is returned from a successful copyright request.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightFromBoundingBoxWithResponse
public com.azure.core.http.rest.Response<Copyright> getCopyrightFromBoundingBoxWithResponse(com.azure.core.models.GeoBoundingBox boundingBox, boolean includeText, com.azure.core.util.Context context) Get Copyright From Bounding Box Returns copyright information for a given bounding box with response. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates.GeoBoundingBox boundingBox = new GeoBoundingBox(52.41064, 4.84228, 52.41072, 4.84239); client.getCopyrightFromBoundingBox(boundingBox, true);
- Parameters:
boundingBox
- theGeoBoundingBox
for which copyright information is needed.includeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.context
- the context associated with this operation.- Returns:
- the copyright information.
-
getCopyrightForTile
Get Copyright For Tile **Applies to**: S0 and S1 pricing tiers. Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. Returns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).client.getCopyrightForTile(new TileIndex().setX(9).setY(22).setZ(6), true);
- Parameters:
tileIndex
- Parameter group.includeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.- Returns:
- this object is returned from a successful copyright request.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightForTileWithResponse
public com.azure.core.http.rest.Response<Copyright> getCopyrightForTileWithResponse(TileIndex tileIndex, boolean includeText, com.azure.core.util.Context context) Get Copyright For Tile Copyrights With Response API is designed to serve copyright information for Render Tile service with response. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. Returns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid)client.getCopyrightForTile(new TileIndex().setX(9).setY(22).setZ(6), true);
- Parameters:
tileIndex
- Parameter groupincludeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.context
- the context associated with this operation.- Returns:
- the copyright for the tile.
-
getCopyrightForWorld
Get Copyright For World **Applies to**: S0 and S1 pricing tiers. Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. Returns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.client.getCopyrightForWorld(true);
- Parameters:
includeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.- Returns:
- this object is returned from a successful copyright request.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.maps.render.implementation.models.ErrorResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getCopyrightForWorldWithResponse
public com.azure.core.http.rest.Response<Copyright> getCopyrightForWorldWithResponse(boolean includeText, com.azure.core.util.Context context) Get Copyright For World Copyrights with response API is designed to serve copyright information with response for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. Returns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.client.getCopyrightForWorld(true);
- Parameters:
includeText
- Yes/no value to exclude textual data from response. Only images and country names will be in response.context
- the context associated with this operation.- Returns:
- the copyright response.
-