diff --git a/sdk/maps/azure-maps-weather/CHANGELOG.md b/sdk/maps/azure-maps-weather/CHANGELOG.md new file mode 100644 index 000000000000..2ee34d2549ef --- /dev/null +++ b/sdk/maps/azure-maps-weather/CHANGELOG.md @@ -0,0 +1,13 @@ +# Release History + +## 1.0.0-beta.1 (Unreleased) + +- Azure AzureMapsWeatherService client library for Java. This package contains Microsoft Azure AzureMapsWeatherService client library. + +### Features Added + +### Breaking Changes + +### Bugs Fixed + +### Other Changes diff --git a/sdk/maps/azure-maps-weather/README.md b/sdk/maps/azure-maps-weather/README.md new file mode 100644 index 000000000000..e71c06e2f2d6 --- /dev/null +++ b/sdk/maps/azure-maps-weather/README.md @@ -0,0 +1,63 @@ +# Azure AzureMapsWeatherService client library for Java + +Azure AzureMapsWeatherService client library for Java. + +This package contains Microsoft Azure AzureMapsWeatherService client library. + +## Documentation + +Various documentation is available to help you get started + +- [API reference documentation][docs] +- [Product documentation][product_documentation] + +## Getting started + +### Prerequisites + +- [Java Development Kit (JDK)][jdk] with version 8 or above +- [Azure Subscription][azure_subscription] + +### Adding the package to your product + +[//]: # ({x-version-update-start;com.azure:azure-maps-weather;current}) +```xml + + com.azure + azure-maps-weather + 1.0.0-beta.1 + +``` +[//]: # ({x-version-update-end}) + +### Authentication + +[Azure Identity][azure_identity] package provides the default implementation for authenticating the client. + +## Key concepts + +## Examples + +```java com.azure.maps.weather.readme +``` + +## Troubleshooting + +## Next steps + +## Contributing + +For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md). + +1. Fork it +1. Create your feature branch (`git checkout -b my-new-feature`) +1. Commit your changes (`git commit -am 'Add some feature'`) +1. Push to the branch (`git push origin my-new-feature`) +1. Create new Pull Request + + +[product_documentation]: https://azure.microsoft.com/services/ +[docs]: https://azure.github.io/azure-sdk-for-java/ +[jdk]: https://docs.microsoft.com/java/azure/jdk/ +[azure_subscription]: https://azure.microsoft.com/free/ +[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity diff --git a/sdk/maps/azure-maps-weather/pom.xml b/sdk/maps/azure-maps-weather/pom.xml new file mode 100644 index 000000000000..53a471c933aa --- /dev/null +++ b/sdk/maps/azure-maps-weather/pom.xml @@ -0,0 +1,73 @@ + + 4.0.0 + + com.azure + azure-client-sdk-parent + 1.7.0 + ../../parents/azure-client-sdk-parent + + + com.azure + azure-maps-weather + 1.0.0-beta.1 + jar + + Microsoft Azure SDK for AzureMapsWeatherService Management + This package contains Microsoft Azure AzureMapsWeatherService client library. + https://github.com/Azure/azure-sdk-for-java + + + + The MIT License (MIT) + http://opensource.org/licenses/MIT + repo + + + + + https://github.com/Azure/azure-sdk-for-java + scm:git:git@github.com:Azure/azure-sdk-for-java.git + scm:git:git@github.com:Azure/azure-sdk-for-java.git + HEAD + + + + microsoft + Microsoft + + + + UTF-8 + true + + + + com.azure + azure-core + 1.25.0 + + + com.azure + azure-core-http-netty + 1.11.7 + + + org.junit.jupiter + junit-jupiter-engine + 5.8.2 + test + + + com.azure + azure-core-test + 1.7.8 + test + + + com.azure + azure-identity + 1.4.5 + test + + + diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceAsyncClient.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceAsyncClient.java new file mode 100644 index 000000000000..eda7e8da15ef --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceAsyncClient.java @@ -0,0 +1,1566 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +import com.azure.core.annotation.Generated; +import com.azure.core.annotation.ReturnType; +import com.azure.core.annotation.ServiceClient; +import com.azure.core.annotation.ServiceMethod; +import com.azure.core.exception.HttpResponseException; +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.maps.weather.implementation.WeathersImpl; +import reactor.core.publisher.Mono; + +/** Initializes a new instance of the asynchronous AzureMapsWeatherServiceClient type. */ +@ServiceClient(builder = AzureMapsWeatherServiceClientBuilder.class, isAsync = true) +public final class AzureMapsWeatherServiceAsyncClient { + @Generated private final WeathersImpl serviceClient; + + /** + * Initializes an instance of Weathers client. + * + * @param serviceClient the service client implementation. + */ + @Generated + AzureMapsWeatherServiceAsyncClient(WeathersImpl serviceClient) { + this.serviceClient = serviceClient; + } + + /** + * **Get Hourly Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and + * 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, + * humidity, wind, precipitation, and ultraviolet (UV) index. + * + *

In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you + * can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days). + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoTime frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are + * * `1` - Return forecast data for the next hour. Default value. + * * `12` - Return hourly forecast for next 12 hours. + * * `24` - Return hourly forecast for next 24 hours. + * * `72` - Return hourly forecast for next 72 hours (3 days). + * * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. + * * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             timestamp: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             hasPrecipitation: Boolean
+     *             isDaylight: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             relativeHumidity: Integer
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             precipitationProbability: Integer
+     *             rainProbability: Integer
+     *             snowProbability: Integer
+     *             iceProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getHourlyForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getHourlyForecastWithResponseAsync(format, requestOptions); + } + + /** + * **Get Minute Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. + * Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details + * such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation + * intensity value (dBZ). + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
intervalStringNoSpecifies time interval in minutes for the returned weather forecast. Supported values are + * * `1` - Retrieve forecast for 1-minute intervals. Returned by default. + * * `5` - Retrieve forecasts for 5-minute intervals. + * * `15` - Retrieve forecasts for 15-minute intervals.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         briefPhrase60: String
+     *         shortDescription: String
+     *         briefDescription: String
+     *         longPhrase: String
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *     }
+     *     intervalSummaries: [
+     *         {
+     *             startMinute: Integer
+     *             endMinute: Integer
+     *             totalMinutes: Integer
+     *             shortDescription: String
+     *             briefDescription: String
+     *             longPhrase: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         }
+     *     ]
+     *     intervals: [
+     *         {
+     *             startTime: String
+     *             minute: Integer
+     *             decibelRelativeToZ: Double
+     *             shortDescription: String
+     *             threshold: String
+     *             color: {
+     *                 red: Integer
+     *                 green: Integer
+     *                 blue: Integer
+     *                 hex: String
+     *             }
+     *             simplifiedColor: (recursive schema, see simplifiedColor above)
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getMinuteForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getMinuteForecastWithResponseAsync(format, requestOptions); + } + + /** + * **Get Quarter-Day Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given + * location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details + * such as temperature, humidity, wind, precipitation, and UV index are returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the quester-day forecast responses are returned. Supported values are: + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for next 10 days. + * * `15` - Return forecast data for the next 15 days.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             effectiveDate: String
+     *             quarter: String(0/1/2/3)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             phrase: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             relativeHumidity: Integer
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCover: Integer
+     *             hasPrecipitation: Boolean
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             precipitationIntensity: String
+     *             precipitationProbability: Integer
+     *             thunderstormProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getQuarterDayForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getQuarterDayForecastWithResponseAsync(format, requestOptions); + } + + /** + * **Get Current Conditions** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature + * and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular + * location can be retrieved. The basic information returned with the response include details such as observation + * date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and + * temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoReturn full details for the current conditions. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.
durationStringNoTime frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: + * * `0` - Return the most current weather conditions. + * * `6` - Return weather conditions from past 6 hours. + * * `24` - Return weather conditions from past 24 hours.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             dateTime: String
+     *             description: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             hasPrecipitation: Boolean
+     *             isDaytime: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             relativeHumidity: Integer
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             visibility: (recursive schema, see visibility above)
+     *             obstructionsToVisibility: String
+     *             cloudCover: Integer
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             pressure: (recursive schema, see pressure above)
+     *             pressureTendency: {
+     *                 description: String
+     *                 code: String
+     *             }
+     *             pastTwentyFourHourTemperatureDeparture: (recursive schema, see pastTwentyFourHourTemperatureDeparture above)
+     *             apparentTemperature: (recursive schema, see apparentTemperature above)
+     *             windChillTemperature: (recursive schema, see windChillTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             precipitationSummary: {
+     *                 pastHour: (recursive schema, see pastHour above)
+     *                 pastThreeHours: (recursive schema, see pastThreeHours above)
+     *                 pastSixHours: (recursive schema, see pastSixHours above)
+     *                 pastNineHours: (recursive schema, see pastNineHours above)
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastEighteenHours: (recursive schema, see pastEighteenHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *             temperatureSummary: {
+     *                 pastSixHours: {
+     *                     minimum: (recursive schema, see minimum above)
+     *                     maximum: (recursive schema, see maximum above)
+     *                 }
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentConditionsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getCurrentConditionsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Daily Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, + * 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, + * precipitation, air quality, and UV index. + * + *

In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily + * forecast for the next 25 days, and 45 days. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the daily forecast responses are returned. Available values are + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for the next 10 days. + * * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. + * * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         startDate: String
+     *         endDate: String
+     *         severity: Integer
+     *         phrase: String
+     *         category: String
+     *     }
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             hoursOfSun: Float
+     *             meanTemperatureDeviation: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             airQuality: [
+     *                 {
+     *                     description: String
+     *                     value: Integer
+     *                     category: String
+     *                     categoryValue: Integer
+     *                     airQualityType: String
+     *                 }
+     *             ]
+     *             daytimeForecast: {
+     *                 iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *                 iconPhrase: String
+     *                 localSource: {
+     *                     id: Integer
+     *                     name: String
+     *                     weatherCode: String
+     *                 }
+     *                 hasPrecipitation: Boolean
+     *                 precipitationType: String(Rain/Snow/Ice/Mix)
+     *                 precipitationIntensity: String
+     *                 shortDescription: String
+     *                 longPhrase: String
+     *                 precipitationProbability: Integer
+     *                 thunderstormProbability: Integer
+     *                 rainProbability: Integer
+     *                 snowProbability: Integer
+     *                 iceProbability: Integer
+     *                 wind: {
+     *                     direction: {
+     *                         degrees: Integer
+     *                         description: String
+     *                     }
+     *                     speed: (recursive schema, see speed above)
+     *                 }
+     *                 windGust: (recursive schema, see windGust above)
+     *                 totalLiquid: (recursive schema, see totalLiquid above)
+     *                 rain: (recursive schema, see rain above)
+     *                 snow: (recursive schema, see snow above)
+     *                 ice: (recursive schema, see ice above)
+     *                 hoursOfPrecipitation: Float
+     *                 hoursOfRain: Float
+     *                 hoursOfSnow: Float
+     *                 hoursOfIce: Float
+     *                 cloudCover: Integer
+     *             }
+     *             nighttimeForecast: (recursive schema, see nighttimeForecast above)
+     *             sources: [
+     *                 String
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyForecastWithResponseAsync(format, requestOptions); + } + + /** + * **Get Weather along route** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, + * weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a + * list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might + * be used to paint each portion of a route according to how safe it is for the driver. When submitting the + * waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or + * shortly after. Data is updated every five minutes. + * + *

The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows + * you to first request a route between an origin and a destination and use that as an input for Weather Along Route + * endpoint. + * + *

In addition, the service supports scenarios to generate weather notifications for waypoints that experience an + * increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy + * rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing + * the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for + * when to display the notification for a waypoint could be based, for example, on a + * [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the + * waypoint. + * + *

The API covers all regions of the planet except latitudes above Greenland and Antarctica. + * + *

Query Parameters + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesCoordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. + * A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where + * * `Latitude` - Latitude coordinate in decimal degrees. + * * `Longitude` - Longitude coordinate in decimal degrees. + * * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. + * * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. + * + * It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         hazards: {
+     *             maxHazardIndex: String(0/1/2/3/4)
+     *             details: [
+     *                 {
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     }
+     *     waypoints: [
+     *         {
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             shortDescription: String
+     *             isDaytime: Boolean
+     *             cloudCover: Integer
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             precipitation: {
+     *                 dbz: Double
+     *                 type: String
+     *             }
+     *             lightningCount: Integer
+     *             sunGlare: {
+     *                 calculatedVehicleHeading: Integer
+     *                 glareIndex: Integer
+     *             }
+     *             hazards: (recursive schema, see hazards above)
+     *             notifications: [
+     *                 {
+     *                     type: String
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Weather Along Route along with {@link Response} on successful + * completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getWeatherAlongRouteWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getWeatherAlongRouteWithResponseAsync(format, requestOptions); + } + + /** + * **Get Severe Weather Alerts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Severe weather phenomenon can significantly impact our everyday life and business operations. For example, + * severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics + * companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of + * refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are + * available worldwide from both official Government Meteorological Agencies and leading global to + * regional weather alert providers. The service can return details such as alert type, category, level and detailed + * description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, + * heat waves or forest fires. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
detailsStringNoReturn full details for the severe weather alerts. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             countryCode: String
+     *             alertId: Integer
+     *             description: {
+     *                 description: String
+     *                 status: String
+     *             }
+     *             category: String
+     *             priority: Integer
+     *             classification: String
+     *             level: String
+     *             source: String
+     *             sourceId: Integer
+     *             disclaimer: String
+     *             alertDetails: [
+     *                 {
+     *                     name: String
+     *                     description: String
+     *                     startTime: String
+     *                     endTime: String
+     *                     latestStatus: {
+     *                         localized: String
+     *                         english: String(New/Extend/Cancel/Correct/Expire/Upgrade/Continue/Update)
+     *                     }
+     *                     details: String
+     *                     language: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Severe Weather Alerts call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getSevereWeatherAlertsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getSevereWeatherAlertsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Daily Indices** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

There may be times when you want to know if the weather conditions are optimal for a specific activity, for + * example, for outdoor construction, indoor activities, running or farming including soil moisture information. + * Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a + * health mobile application can notify users that today is good weather for running or for other outdoors + * activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on + * predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days + * starting from current day. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
durationStringNoSpecifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are + * * `1` - Return daily index data for the current day. Default value. + * * `5` - Return 5 days of daily index data starting from the current day. + * * `10` - Return 10 days of daily index data starting from the current day. + * * `15` - Return 15 days of daily index data starting from the current day.
indexIdStringNoNumeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
indexGroupIdStringNoNumeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             indexName: String
+     *             indexId: Integer
+     *             dateTime: String
+     *             value: Float
+     *             categoryDescription: String
+     *             categoryValue: Integer
+     *             isAscending: Boolean
+     *             description: String
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Indices call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyIndicesWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyIndicesWithResponseAsync(format, requestOptions); + } + + /** + * **Get Tropical Storm Active** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get all government-issued active tropical storms. Information about the tropical storms includes, government + * ID, basin ID, year of origin, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     activeStorms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return all government-issued active storms along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormActiveWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormActiveWithResponseAsync(format, requestOptions); + } + + /** + * **Get Tropical Storm Search** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Search government-issued tropical storms by year, basin ID, and government ID. Information about the tropical + * storms includes, government ID, basin ID, status, year, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringNoBasin identifier
govIdStringNoGovernment storm Id
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     storms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isRetired: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return search government-issued storms along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> searchTropicalStormWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.searchTropicalStormWithResponseAsync(format, requestOptions); + } + + /** + * **Get Tropical Storm Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get individual government-issued tropical storm forecasts. Information about the forecasted tropical storms + * includes, location, status, date the forecast was created, window, wind speed and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
windowGeometryStringNoWhen true, window geometry data (geoJSON) is included in the response
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormForecasts: [
+     *         {
+     *             timestamp: String
+     *             initializedTimestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             status: String
+     *             weatherWindow: {
+     *                 topLeft: (recursive schema, see topLeft above)
+     *                 bottomRight: (recursive schema, see bottomRight above)
+     *                 beginTimestamp: String
+     *                 endTimestamp: String
+     *                 beginStatus: String
+     *                 endStatus: String
+     *                 geometry: {
+     *                 }
+     *             }
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: (recursive schema, see radiiGeometry above)
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the list of Government-issued forecasts along with {@link Response} on successful completion of {@link + * Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormForecastWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormForecastWithResponseAsync(format, requestOptions); + } + + /** + * **Get Tropical Storm Locations** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get location of individual government-issued tropical storms. Information about the tropical storms includes, + * location coordinates, geometry, basin ID, date, wind details and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
currentStringNoWhen true, return the current storm location
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormLocations: [
+     *         {
+     *             timestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             minimumPressure: (recursive schema, see minimumPressure above)
+     *             movement: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             status: String
+     *             isSubtropical: Boolean
+     *             hasTropicalPotential: Boolean
+     *             isPostTropical: Boolean
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: {
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return locations for an individual government-issued storm along with {@link Response} on successful completion + * of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormLocationsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormLocationsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Current Air Quality** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for current air quality. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentAirQualityWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getCurrentAirQualityWithResponseAsync(format, requestOptions); + } + + /** + * **Get Air Quality Daily Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status of forecasted daily air + * quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Air Quality Forecast call along with {@link Response} + * on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityDailyForecastsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getAirQualityDailyForecastsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Air Quality Hourly Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for forecasted upcoming + * hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans + * of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the + * dominant pollutant, and a brief statement summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityHourlyForecastsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getAirQualityHourlyForecastsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Daily Historical Actuals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, + * precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate + * location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, + * historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalActuals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *             snowfall: (recursive schema, see snowfall above)
+     *             snowDepth: (recursive schema, see snowDepth above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalActualsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalActualsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Daily Historical Records** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Records service returns climatology data such as past daily record temperatures, + * precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. + * Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalRecords: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unit: String
+     *                     unitType: Integer
+     *                     year: Integer
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *             }
+     *             precipitation: {
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             snowfall: (recursive schema, see snowfall above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalRecordsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalRecordsWithResponseAsync(format, requestOptions); + } + + /** + * **Get Daily Historical Normals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Normals service returns climatology data such as past daily normal temperatures, + * precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are + * a 30-year average for temperatures and precipitation for a specific location. As is standard practice in + * climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will + * reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, + * depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalNormals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalNormalsWithResponse( + String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalNormalsWithResponseAsync(format, requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClient.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClient.java new file mode 100644 index 000000000000..2738d6f74641 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClient.java @@ -0,0 +1,1551 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +import com.azure.core.annotation.Generated; +import com.azure.core.annotation.ReturnType; +import com.azure.core.annotation.ServiceClient; +import com.azure.core.annotation.ServiceMethod; +import com.azure.core.exception.HttpResponseException; +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.maps.weather.implementation.WeathersImpl; + +/** Initializes a new instance of the synchronous AzureMapsWeatherServiceClient type. */ +@ServiceClient(builder = AzureMapsWeatherServiceClientBuilder.class) +public final class AzureMapsWeatherServiceClient { + @Generated private final WeathersImpl serviceClient; + + /** + * Initializes an instance of Weathers client. + * + * @param serviceClient the service client implementation. + */ + @Generated + AzureMapsWeatherServiceClient(WeathersImpl serviceClient) { + this.serviceClient = serviceClient; + } + + /** + * **Get Hourly Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and + * 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, + * humidity, wind, precipitation, and ultraviolet (UV) index. + * + *

In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you + * can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days). + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoTime frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are + * * `1` - Return forecast data for the next hour. Default value. + * * `12` - Return hourly forecast for next 12 hours. + * * `24` - Return hourly forecast for next 24 hours. + * * `72` - Return hourly forecast for next 72 hours (3 days). + * * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. + * * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             timestamp: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             hasPrecipitation: Boolean
+     *             isDaylight: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             relativeHumidity: Integer
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             precipitationProbability: Integer
+     *             rainProbability: Integer
+     *             snowProbability: Integer
+     *             iceProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getHourlyForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getHourlyForecastWithResponse(format, requestOptions); + } + + /** + * **Get Minute Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. + * Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details + * such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation + * intensity value (dBZ). + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
intervalStringNoSpecifies time interval in minutes for the returned weather forecast. Supported values are + * * `1` - Retrieve forecast for 1-minute intervals. Returned by default. + * * `5` - Retrieve forecasts for 5-minute intervals. + * * `15` - Retrieve forecasts for 15-minute intervals.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         briefPhrase60: String
+     *         shortDescription: String
+     *         briefDescription: String
+     *         longPhrase: String
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *     }
+     *     intervalSummaries: [
+     *         {
+     *             startMinute: Integer
+     *             endMinute: Integer
+     *             totalMinutes: Integer
+     *             shortDescription: String
+     *             briefDescription: String
+     *             longPhrase: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         }
+     *     ]
+     *     intervals: [
+     *         {
+     *             startTime: String
+     *             minute: Integer
+     *             decibelRelativeToZ: Double
+     *             shortDescription: String
+     *             threshold: String
+     *             color: {
+     *                 red: Integer
+     *                 green: Integer
+     *                 blue: Integer
+     *                 hex: String
+     *             }
+     *             simplifiedColor: (recursive schema, see simplifiedColor above)
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getMinuteForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getMinuteForecastWithResponse(format, requestOptions); + } + + /** + * **Get Quarter-Day Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given + * location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details + * such as temperature, humidity, wind, precipitation, and UV index are returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the quester-day forecast responses are returned. Supported values are: + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for next 10 days. + * * `15` - Return forecast data for the next 15 days.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             effectiveDate: String
+     *             quarter: String(0/1/2/3)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             phrase: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             relativeHumidity: Integer
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCover: Integer
+     *             hasPrecipitation: Boolean
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             precipitationIntensity: String
+     *             precipitationProbability: Integer
+     *             thunderstormProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getQuarterDayForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getQuarterDayForecastWithResponse(format, requestOptions); + } + + /** + * **Get Current Conditions** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature + * and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular + * location can be retrieved. The basic information returned with the response include details such as observation + * date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and + * temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoReturn full details for the current conditions. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.
durationStringNoTime frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: + * * `0` - Return the most current weather conditions. + * * `6` - Return weather conditions from past 6 hours. + * * `24` - Return weather conditions from past 24 hours.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             dateTime: String
+     *             description: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             hasPrecipitation: Boolean
+     *             isDaytime: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             relativeHumidity: Integer
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             visibility: (recursive schema, see visibility above)
+     *             obstructionsToVisibility: String
+     *             cloudCover: Integer
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             pressure: (recursive schema, see pressure above)
+     *             pressureTendency: {
+     *                 description: String
+     *                 code: String
+     *             }
+     *             pastTwentyFourHourTemperatureDeparture: (recursive schema, see pastTwentyFourHourTemperatureDeparture above)
+     *             apparentTemperature: (recursive schema, see apparentTemperature above)
+     *             windChillTemperature: (recursive schema, see windChillTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             precipitationSummary: {
+     *                 pastHour: (recursive schema, see pastHour above)
+     *                 pastThreeHours: (recursive schema, see pastThreeHours above)
+     *                 pastSixHours: (recursive schema, see pastSixHours above)
+     *                 pastNineHours: (recursive schema, see pastNineHours above)
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastEighteenHours: (recursive schema, see pastEighteenHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *             temperatureSummary: {
+     *                 pastSixHours: {
+     *                     minimum: (recursive schema, see minimum above)
+     *                     maximum: (recursive schema, see maximum above)
+     *                 }
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getCurrentConditionsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getCurrentConditionsWithResponse(format, requestOptions); + } + + /** + * **Get Daily Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, + * 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, + * precipitation, air quality, and UV index. + * + *

In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily + * forecast for the next 25 days, and 45 days. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the daily forecast responses are returned. Available values are + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for the next 10 days. + * * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. + * * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         startDate: String
+     *         endDate: String
+     *         severity: Integer
+     *         phrase: String
+     *         category: String
+     *     }
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             hoursOfSun: Float
+     *             meanTemperatureDeviation: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             airQuality: [
+     *                 {
+     *                     description: String
+     *                     value: Integer
+     *                     category: String
+     *                     categoryValue: Integer
+     *                     airQualityType: String
+     *                 }
+     *             ]
+     *             daytimeForecast: {
+     *                 iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *                 iconPhrase: String
+     *                 localSource: {
+     *                     id: Integer
+     *                     name: String
+     *                     weatherCode: String
+     *                 }
+     *                 hasPrecipitation: Boolean
+     *                 precipitationType: String(Rain/Snow/Ice/Mix)
+     *                 precipitationIntensity: String
+     *                 shortDescription: String
+     *                 longPhrase: String
+     *                 precipitationProbability: Integer
+     *                 thunderstormProbability: Integer
+     *                 rainProbability: Integer
+     *                 snowProbability: Integer
+     *                 iceProbability: Integer
+     *                 wind: {
+     *                     direction: {
+     *                         degrees: Integer
+     *                         description: String
+     *                     }
+     *                     speed: (recursive schema, see speed above)
+     *                 }
+     *                 windGust: (recursive schema, see windGust above)
+     *                 totalLiquid: (recursive schema, see totalLiquid above)
+     *                 rain: (recursive schema, see rain above)
+     *                 snow: (recursive schema, see snow above)
+     *                 ice: (recursive schema, see ice above)
+     *                 hoursOfPrecipitation: Float
+     *                 hoursOfRain: Float
+     *                 hoursOfSnow: Float
+     *                 hoursOfIce: Float
+     *                 cloudCover: Integer
+     *             }
+     *             nighttimeForecast: (recursive schema, see nighttimeForecast above)
+     *             sources: [
+     *                 String
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyForecastWithResponse(format, requestOptions); + } + + /** + * **Get Weather along route** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, + * weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a + * list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might + * be used to paint each portion of a route according to how safe it is for the driver. When submitting the + * waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or + * shortly after. Data is updated every five minutes. + * + *

The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows + * you to first request a route between an origin and a destination and use that as an input for Weather Along Route + * endpoint. + * + *

In addition, the service supports scenarios to generate weather notifications for waypoints that experience an + * increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy + * rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing + * the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for + * when to display the notification for a waypoint could be based, for example, on a + * [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the + * waypoint. + * + *

The API covers all regions of the planet except latitudes above Greenland and Antarctica. + * + *

Query Parameters + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesCoordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. + * A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where + * * `Latitude` - Latitude coordinate in decimal degrees. + * * `Longitude` - Longitude coordinate in decimal degrees. + * * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. + * * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. + * + * It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         hazards: {
+     *             maxHazardIndex: String(0/1/2/3/4)
+     *             details: [
+     *                 {
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     }
+     *     waypoints: [
+     *         {
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             shortDescription: String
+     *             isDaytime: Boolean
+     *             cloudCover: Integer
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             precipitation: {
+     *                 dbz: Double
+     *                 type: String
+     *             }
+     *             lightningCount: Integer
+     *             sunGlare: {
+     *                 calculatedVehicleHeading: Integer
+     *                 glareIndex: Integer
+     *             }
+     *             hazards: (recursive schema, see hazards above)
+     *             notifications: [
+     *                 {
+     *                     type: String
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Weather Along Route along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getWeatherAlongRouteWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getWeatherAlongRouteWithResponse(format, requestOptions); + } + + /** + * **Get Severe Weather Alerts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Severe weather phenomenon can significantly impact our everyday life and business operations. For example, + * severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics + * companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of + * refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are + * available worldwide from both official Government Meteorological Agencies and leading global to + * regional weather alert providers. The service can return details such as alert type, category, level and detailed + * description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, + * heat waves or forest fires. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
detailsStringNoReturn full details for the severe weather alerts. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             countryCode: String
+     *             alertId: Integer
+     *             description: {
+     *                 description: String
+     *                 status: String
+     *             }
+     *             category: String
+     *             priority: Integer
+     *             classification: String
+     *             level: String
+     *             source: String
+     *             sourceId: Integer
+     *             disclaimer: String
+     *             alertDetails: [
+     *                 {
+     *                     name: String
+     *                     description: String
+     *                     startTime: String
+     *                     endTime: String
+     *                     latestStatus: {
+     *                         localized: String
+     *                         english: String(New/Extend/Cancel/Correct/Expire/Upgrade/Continue/Update)
+     *                     }
+     *                     details: String
+     *                     language: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Severe Weather Alerts call along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getSevereWeatherAlertsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getSevereWeatherAlertsWithResponse(format, requestOptions); + } + + /** + * **Get Daily Indices** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

There may be times when you want to know if the weather conditions are optimal for a specific activity, for + * example, for outdoor construction, indoor activities, running or farming including soil moisture information. + * Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a + * health mobile application can notify users that today is good weather for running or for other outdoors + * activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on + * predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days + * starting from current day. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
durationStringNoSpecifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are + * * `1` - Return daily index data for the current day. Default value. + * * `5` - Return 5 days of daily index data starting from the current day. + * * `10` - Return 10 days of daily index data starting from the current day. + * * `15` - Return 15 days of daily index data starting from the current day.
indexIdStringNoNumeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
indexGroupIdStringNoNumeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             indexName: String
+     *             indexId: Integer
+     *             dateTime: String
+     *             value: Float
+     *             categoryDescription: String
+     *             categoryValue: Integer
+     *             isAscending: Boolean
+     *             description: String
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Indices call along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyIndicesWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyIndicesWithResponse(format, requestOptions); + } + + /** + * **Get Tropical Storm Active** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get all government-issued active tropical storms. Information about the tropical storms includes, government + * ID, basin ID, year of origin, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     activeStorms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return all government-issued active storms along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormActiveWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormActiveWithResponse(format, requestOptions); + } + + /** + * **Get Tropical Storm Search** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Search government-issued tropical storms by year, basin ID, and government ID. Information about the tropical + * storms includes, government ID, basin ID, status, year, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringNoBasin identifier
govIdStringNoGovernment storm Id
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     storms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isRetired: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return search government-issued storms along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response searchTropicalStormWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.searchTropicalStormWithResponse(format, requestOptions); + } + + /** + * **Get Tropical Storm Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get individual government-issued tropical storm forecasts. Information about the forecasted tropical storms + * includes, location, status, date the forecast was created, window, wind speed and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
windowGeometryStringNoWhen true, window geometry data (geoJSON) is included in the response
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormForecasts: [
+     *         {
+     *             timestamp: String
+     *             initializedTimestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             status: String
+     *             weatherWindow: {
+     *                 topLeft: (recursive schema, see topLeft above)
+     *                 bottomRight: (recursive schema, see bottomRight above)
+     *                 beginTimestamp: String
+     *                 endTimestamp: String
+     *                 beginStatus: String
+     *                 endStatus: String
+     *                 geometry: {
+     *                 }
+     *             }
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: (recursive schema, see radiiGeometry above)
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the list of Government-issued forecasts along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormForecastWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormForecastWithResponse(format, requestOptions); + } + + /** + * **Get Tropical Storm Locations** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get location of individual government-issued tropical storms. Information about the tropical storms includes, + * location coordinates, geometry, basin ID, date, wind details and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
currentStringNoWhen true, return the current storm location
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormLocations: [
+     *         {
+     *             timestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             minimumPressure: (recursive schema, see minimumPressure above)
+     *             movement: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             status: String
+     *             isSubtropical: Boolean
+     *             hasTropicalPotential: Boolean
+     *             isPostTropical: Boolean
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: {
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return locations for an individual government-issued storm along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormLocationsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getTropicalStormLocationsWithResponse(format, requestOptions); + } + + /** + * **Get Current Air Quality** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for current air quality. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getCurrentAirQualityWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getCurrentAirQualityWithResponse(format, requestOptions); + } + + /** + * **Get Air Quality Daily Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status of forecasted daily air + * quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Air Quality Forecast call along with {@link + * Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getAirQualityDailyForecastsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getAirQualityDailyForecastsWithResponse(format, requestOptions); + } + + /** + * **Get Air Quality Hourly Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for forecasted upcoming + * hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans + * of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the + * dominant pollutant, and a brief statement summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getAirQualityHourlyForecastsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getAirQualityHourlyForecastsWithResponse(format, requestOptions); + } + + /** + * **Get Daily Historical Actuals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, + * precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate + * location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, + * historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalActuals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *             snowfall: (recursive schema, see snowfall above)
+     *             snowDepth: (recursive schema, see snowDepth above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalActualsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalActualsWithResponse(format, requestOptions); + } + + /** + * **Get Daily Historical Records** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Records service returns climatology data such as past daily record temperatures, + * precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. + * Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalRecords: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unit: String
+     *                     unitType: Integer
+     *                     year: Integer
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *             }
+     *             precipitation: {
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             snowfall: (recursive schema, see snowfall above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalRecordsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalRecordsWithResponse(format, requestOptions); + } + + /** + * **Get Daily Historical Normals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Normals service returns climatology data such as past daily normal temperatures, + * precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are + * a 30-year average for temperatures and precipitation for a specific location. As is standard practice in + * climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will + * reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, + * depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalNormals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalNormalsWithResponse(String format, RequestOptions requestOptions) { + return this.serviceClient.getDailyHistoricalNormalsWithResponse(format, requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClientBuilder.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClientBuilder.java new file mode 100644 index 000000000000..ea848e8b0879 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceClientBuilder.java @@ -0,0 +1,333 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +import com.azure.core.annotation.Generated; +import com.azure.core.annotation.ServiceClientBuilder; +import com.azure.core.credential.TokenCredential; +import com.azure.core.http.HttpClient; +import com.azure.core.http.HttpHeaders; +import com.azure.core.http.HttpPipeline; +import com.azure.core.http.HttpPipelineBuilder; +import com.azure.core.http.HttpPipelinePosition; +import com.azure.core.http.policy.AddHeadersPolicy; +import com.azure.core.http.policy.BearerTokenAuthenticationPolicy; +import com.azure.core.http.policy.CookiePolicy; +import com.azure.core.http.policy.HttpLogOptions; +import com.azure.core.http.policy.HttpLoggingPolicy; +import com.azure.core.http.policy.HttpPipelinePolicy; +import com.azure.core.http.policy.HttpPolicyProviders; +import com.azure.core.http.policy.RetryPolicy; +import com.azure.core.http.policy.UserAgentPolicy; +import com.azure.core.util.ClientOptions; +import com.azure.core.util.Configuration; +import com.azure.core.util.CoreUtils; +import com.azure.core.util.serializer.JacksonAdapter; +import com.azure.maps.weather.implementation.AzureMapsWeatherServiceClientImpl; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +/** A builder for creating a new instance of the AzureMapsWeatherServiceClient type. */ +@ServiceClientBuilder(serviceClients = {AzureMapsWeatherServiceClient.class, AzureMapsWeatherServiceAsyncClient.class}) +public final class AzureMapsWeatherServiceClientBuilder { + @Generated private static final String SDK_NAME = "name"; + + @Generated private static final String SDK_VERSION = "version"; + + @Generated private static final String[] DEFAULT_SCOPES = new String[] {"https://atlas.microsoft.com/.default"}; + + @Generated private final Map properties = CoreUtils.getProperties("azure-maps-weather.properties"); + + /** Create an instance of the AzureMapsWeatherServiceClientBuilder. */ + @Generated + public AzureMapsWeatherServiceClientBuilder() { + this.pipelinePolicies = new ArrayList<>(); + } + + /* + * Specifies which account is intended for usage in conjunction with the + * Azure AD security model. It represents a unique ID for the Azure Maps + * account and can be retrieved from the Azure Maps management plane + * Account API. To use Azure AD security in Azure Maps see the following + * [articles](https://aka.ms/amauthdetails) for guidance. + */ + @Generated private String clientId; + + /** + * Sets Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents + * a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To + * use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. + * + * @param clientId the clientId value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /* + * server parameter + */ + @Generated private String host; + + /** + * Sets server parameter. + * + * @param host the host value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder host(String host) { + this.host = host; + return this; + } + + /* + * Service version + */ + @Generated private AzureMapsWeatherServiceVersion serviceVersion; + + /** + * Sets Service version. + * + * @param serviceVersion the serviceVersion value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder serviceVersion(AzureMapsWeatherServiceVersion serviceVersion) { + this.serviceVersion = serviceVersion; + return this; + } + + /* + * The HTTP pipeline to send requests through + */ + @Generated private HttpPipeline pipeline; + + /** + * Sets The HTTP pipeline to send requests through. + * + * @param pipeline the pipeline value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder pipeline(HttpPipeline pipeline) { + this.pipeline = pipeline; + return this; + } + + /* + * The HTTP client used to send the request. + */ + @Generated private HttpClient httpClient; + + /** + * Sets The HTTP client used to send the request. + * + * @param httpClient the httpClient value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder httpClient(HttpClient httpClient) { + this.httpClient = httpClient; + return this; + } + + /* + * The configuration store that is used during construction of the service + * client. + */ + @Generated private Configuration configuration; + + /** + * Sets The configuration store that is used during construction of the service client. + * + * @param configuration the configuration value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder configuration(Configuration configuration) { + this.configuration = configuration; + return this; + } + + /* + * The TokenCredential used for authentication. + */ + @Generated private TokenCredential tokenCredential; + + /** + * Sets The TokenCredential used for authentication. + * + * @param tokenCredential the tokenCredential value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder credential(TokenCredential tokenCredential) { + this.tokenCredential = tokenCredential; + return this; + } + + /* + * The logging configuration for HTTP requests and responses. + */ + @Generated private HttpLogOptions httpLogOptions; + + /** + * Sets The logging configuration for HTTP requests and responses. + * + * @param httpLogOptions the httpLogOptions value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder httpLogOptions(HttpLogOptions httpLogOptions) { + this.httpLogOptions = httpLogOptions; + return this; + } + + /* + * The retry policy that will attempt to retry failed requests, if + * applicable. + */ + @Generated private RetryPolicy retryPolicy; + + /** + * Sets The retry policy that will attempt to retry failed requests, if applicable. + * + * @param retryPolicy the retryPolicy value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder retryPolicy(RetryPolicy retryPolicy) { + this.retryPolicy = retryPolicy; + return this; + } + + /* + * The list of Http pipeline policies to add. + */ + @Generated private final List pipelinePolicies; + + /* + * The client options such as application ID and custom headers to set on a + * request. + */ + @Generated private ClientOptions clientOptions; + + /** + * Sets The client options such as application ID and custom headers to set on a request. + * + * @param clientOptions the clientOptions value. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder clientOptions(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + return this; + } + + /** + * Adds a custom Http pipeline policy. + * + * @param customPolicy The custom Http pipeline policy to add. + * @return the AzureMapsWeatherServiceClientBuilder. + */ + @Generated + public AzureMapsWeatherServiceClientBuilder addPolicy(HttpPipelinePolicy customPolicy) { + pipelinePolicies.add(customPolicy); + return this; + } + + /** + * Builds an instance of AzureMapsWeatherServiceClientImpl with the provided parameters. + * + * @return an instance of AzureMapsWeatherServiceClientImpl. + */ + @Generated + private AzureMapsWeatherServiceClientImpl buildInnerClient() { + if (host == null) { + this.host = "https://atlas.microsoft.com"; + } + if (serviceVersion == null) { + this.serviceVersion = AzureMapsWeatherServiceVersion.getLatest(); + } + if (pipeline == null) { + this.pipeline = createHttpPipeline(); + } + AzureMapsWeatherServiceClientImpl client = + new AzureMapsWeatherServiceClientImpl( + pipeline, JacksonAdapter.createDefaultSerializerAdapter(), clientId, host, serviceVersion); + return client; + } + + @Generated + private HttpPipeline createHttpPipeline() { + Configuration buildConfiguration = + (configuration == null) ? Configuration.getGlobalConfiguration() : configuration; + if (httpLogOptions == null) { + httpLogOptions = new HttpLogOptions(); + } + if (clientOptions == null) { + clientOptions = new ClientOptions(); + } + List policies = new ArrayList<>(); + String clientName = properties.getOrDefault(SDK_NAME, "UnknownName"); + String clientVersion = properties.getOrDefault(SDK_VERSION, "UnknownVersion"); + String applicationId = CoreUtils.getApplicationId(clientOptions, httpLogOptions); + policies.add(new UserAgentPolicy(applicationId, clientName, clientVersion, buildConfiguration)); + HttpHeaders headers = new HttpHeaders(); + clientOptions.getHeaders().forEach(header -> headers.set(header.getName(), header.getValue())); + if (headers.getSize() > 0) { + policies.add(new AddHeadersPolicy(headers)); + } + policies.addAll( + this.pipelinePolicies.stream() + .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL) + .collect(Collectors.toList())); + HttpPolicyProviders.addBeforeRetryPolicies(policies); + policies.add(retryPolicy == null ? new RetryPolicy() : retryPolicy); + policies.add(new CookiePolicy()); + if (tokenCredential != null) { + policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES)); + } + policies.addAll( + this.pipelinePolicies.stream() + .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY) + .collect(Collectors.toList())); + HttpPolicyProviders.addAfterRetryPolicies(policies); + policies.add(new HttpLoggingPolicy(httpLogOptions)); + HttpPipeline httpPipeline = + new HttpPipelineBuilder() + .policies(policies.toArray(new HttpPipelinePolicy[0])) + .httpClient(httpClient) + .clientOptions(clientOptions) + .build(); + return httpPipeline; + } + + /** + * Builds an instance of AzureMapsWeatherServiceAsyncClient async client. + * + * @return an instance of AzureMapsWeatherServiceAsyncClient. + */ + @Generated + public AzureMapsWeatherServiceAsyncClient buildAsyncClient() { + return new AzureMapsWeatherServiceAsyncClient(buildInnerClient().getWeathers()); + } + + /** + * Builds an instance of AzureMapsWeatherServiceClient sync client. + * + * @return an instance of AzureMapsWeatherServiceClient. + */ + @Generated + public AzureMapsWeatherServiceClient buildClient() { + return new AzureMapsWeatherServiceClient(buildInnerClient().getWeathers()); + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceVersion.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceVersion.java new file mode 100644 index 000000000000..cbed3c4ed715 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/AzureMapsWeatherServiceVersion.java @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +import com.azure.core.util.ServiceVersion; + +/** Service version of AzureMapsWeatherServiceClient. */ +public enum AzureMapsWeatherServiceVersion implements ServiceVersion { + /** Enum value 1.1. */ + V1_1("1.1"); + + private final String version; + + AzureMapsWeatherServiceVersion(String version) { + this.version = version; + } + + @Override + public String getVersion() { + return this.version; + } + + /** + * Gets the latest service version supported by this client library. + * + * @return The latest {@link AzureMapsWeatherServiceVersion}. + */ + public static AzureMapsWeatherServiceVersion getLatest() { + return V1_1; + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/AzureMapsWeatherServiceClientImpl.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/AzureMapsWeatherServiceClientImpl.java new file mode 100644 index 000000000000..03477b407727 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/AzureMapsWeatherServiceClientImpl.java @@ -0,0 +1,159 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.implementation; + +import com.azure.core.http.HttpPipeline; +import com.azure.core.http.HttpPipelineBuilder; +import com.azure.core.http.policy.CookiePolicy; +import com.azure.core.http.policy.RetryPolicy; +import com.azure.core.http.policy.UserAgentPolicy; +import com.azure.core.util.serializer.JacksonAdapter; +import com.azure.core.util.serializer.SerializerAdapter; +import com.azure.maps.weather.AzureMapsWeatherServiceVersion; + +/** Initializes a new instance of the AzureMapsWeatherServiceClient type. */ +public final class AzureMapsWeatherServiceClientImpl { + /** + * Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a + * unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To + * use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. + */ + private final String clientId; + + /** + * Gets Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents + * a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To + * use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. + * + * @return the clientId value. + */ + public String getClientId() { + return this.clientId; + } + + /** server parameter. */ + private final String host; + + /** + * Gets server parameter. + * + * @return the host value. + */ + public String getHost() { + return this.host; + } + + /** Service version. */ + private final AzureMapsWeatherServiceVersion serviceVersion; + + /** + * Gets Service version. + * + * @return the serviceVersion value. + */ + public AzureMapsWeatherServiceVersion getServiceVersion() { + return this.serviceVersion; + } + + /** The HTTP pipeline to send requests through. */ + private final HttpPipeline httpPipeline; + + /** + * Gets The HTTP pipeline to send requests through. + * + * @return the httpPipeline value. + */ + public HttpPipeline getHttpPipeline() { + return this.httpPipeline; + } + + /** The serializer to serialize an object into a string. */ + private final SerializerAdapter serializerAdapter; + + /** + * Gets The serializer to serialize an object into a string. + * + * @return the serializerAdapter value. + */ + public SerializerAdapter getSerializerAdapter() { + return this.serializerAdapter; + } + + /** The WeathersImpl object to access its operations. */ + private final WeathersImpl weathers; + + /** + * Gets the WeathersImpl object to access its operations. + * + * @return the WeathersImpl object. + */ + public WeathersImpl getWeathers() { + return this.weathers; + } + + /** + * Initializes an instance of AzureMapsWeatherServiceClient client. + * + * @param clientId Specifies which account is intended for usage in conjunction with the Azure AD security model. It + * represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane + * Account API. To use Azure AD security in Azure Maps see the following + * [articles](https://aka.ms/amauthdetails) for guidance. + * @param host server parameter. + * @param serviceVersion Service version. + */ + public AzureMapsWeatherServiceClientImpl( + String clientId, String host, AzureMapsWeatherServiceVersion serviceVersion) { + this( + new HttpPipelineBuilder() + .policies(new UserAgentPolicy(), new RetryPolicy(), new CookiePolicy()) + .build(), + JacksonAdapter.createDefaultSerializerAdapter(), + clientId, + host, + serviceVersion); + } + + /** + * Initializes an instance of AzureMapsWeatherServiceClient client. + * + * @param httpPipeline The HTTP pipeline to send requests through. + * @param clientId Specifies which account is intended for usage in conjunction with the Azure AD security model. It + * represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane + * Account API. To use Azure AD security in Azure Maps see the following + * [articles](https://aka.ms/amauthdetails) for guidance. + * @param host server parameter. + * @param serviceVersion Service version. + */ + public AzureMapsWeatherServiceClientImpl( + HttpPipeline httpPipeline, String clientId, String host, AzureMapsWeatherServiceVersion serviceVersion) { + this(httpPipeline, JacksonAdapter.createDefaultSerializerAdapter(), clientId, host, serviceVersion); + } + + /** + * Initializes an instance of AzureMapsWeatherServiceClient client. + * + * @param httpPipeline The HTTP pipeline to send requests through. + * @param serializerAdapter The serializer to serialize an object into a string. + * @param clientId Specifies which account is intended for usage in conjunction with the Azure AD security model. It + * represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane + * Account API. To use Azure AD security in Azure Maps see the following + * [articles](https://aka.ms/amauthdetails) for guidance. + * @param host server parameter. + * @param serviceVersion Service version. + */ + public AzureMapsWeatherServiceClientImpl( + HttpPipeline httpPipeline, + SerializerAdapter serializerAdapter, + String clientId, + String host, + AzureMapsWeatherServiceVersion serviceVersion) { + this.httpPipeline = httpPipeline; + this.serializerAdapter = serializerAdapter; + this.clientId = clientId; + this.host = host; + this.serviceVersion = serviceVersion; + this.weathers = new WeathersImpl(this); + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/WeathersImpl.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/WeathersImpl.java new file mode 100644 index 000000000000..5eb13b4fd7f2 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/implementation/WeathersImpl.java @@ -0,0 +1,4926 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.implementation; + +import com.azure.core.annotation.ExpectedResponses; +import com.azure.core.annotation.Get; +import com.azure.core.annotation.Host; +import com.azure.core.annotation.HostParam; +import com.azure.core.annotation.PathParam; +import com.azure.core.annotation.QueryParam; +import com.azure.core.annotation.ReturnType; +import com.azure.core.annotation.ServiceInterface; +import com.azure.core.annotation.ServiceMethod; +import com.azure.core.exception.HttpResponseException; +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.http.rest.RestProxy; +import com.azure.core.util.BinaryData; +import com.azure.core.util.Context; +import com.azure.core.util.FluxUtil; +import reactor.core.publisher.Mono; + +/** An instance of this class provides access to all the operations defined in Weathers. */ +public final class WeathersImpl { + /** The proxy service used to perform REST calls. */ + private final WeathersService service; + + /** The service client containing this operation class. */ + private final AzureMapsWeatherServiceClientImpl client; + + /** + * Initializes an instance of WeathersImpl. + * + * @param client the instance of the service client containing this operation class. + */ + WeathersImpl(AzureMapsWeatherServiceClientImpl client) { + this.service = RestProxy.create(WeathersService.class, client.getHttpPipeline(), client.getSerializerAdapter()); + this.client = client; + } + + /** + * The interface defining all the services for AzureMapsWeatherServiceWeathers to be used by the proxy service to + * perform REST calls. + */ + @Host("{$host}") + @ServiceInterface(name = "AzureMapsWeatherServ") + private interface WeathersService { + @Get("/weather/forecast/hourly/{format}") + @ExpectedResponses({200}) + Mono> getHourlyForecast( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/forecast/minute/{format}") + @ExpectedResponses({200}) + Mono> getMinuteForecast( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/forecast/quarterDay/{format}") + @ExpectedResponses({200}) + Mono> getQuarterDayForecast( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/currentConditions/{format}") + @ExpectedResponses({200}) + Mono> getCurrentConditions( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/forecast/daily/{format}") + @ExpectedResponses({200}) + Mono> getDailyForecast( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/route/{format}") + @ExpectedResponses({200}) + Mono> getWeatherAlongRoute( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/severe/alerts/{format}") + @ExpectedResponses({200}) + Mono> getSevereWeatherAlerts( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/indices/daily/{format}") + @ExpectedResponses({200}) + Mono> getDailyIndices( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/tropical/storms/active/{format}") + @ExpectedResponses({200}) + Mono> getTropicalStormActive( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/tropical/storms/{format}") + @ExpectedResponses({200}) + Mono> searchTropicalStorm( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/tropical/storms/forecasts/{format}") + @ExpectedResponses({200}) + Mono> getTropicalStormForecast( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/tropical/storms/locations/{format}") + @ExpectedResponses({200}) + Mono> getTropicalStormLocations( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/airQuality/current/{format}") + @ExpectedResponses({200}) + Mono> getCurrentAirQuality( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/airQuality/forecasts/daily/{format}") + @ExpectedResponses({200}) + Mono> getAirQualityDailyForecasts( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/airQuality/forecasts/hourly/{format}") + @ExpectedResponses({200}) + Mono> getAirQualityHourlyForecasts( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/historical/actuals/daily/{format}") + @ExpectedResponses({200}) + Mono> getDailyHistoricalActuals( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/historical/records/daily/{format}") + @ExpectedResponses({200}) + Mono> getDailyHistoricalRecords( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + + @Get("/weather/historical/normals/daily/{format}") + @ExpectedResponses({200}) + Mono> getDailyHistoricalNormals( + @HostParam("$host") String host, + @QueryParam("api-version") String apiVersion, + @PathParam("format") String format, + RequestOptions requestOptions, + Context context); + } + + /** + * **Get Hourly Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and + * 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, + * humidity, wind, precipitation, and ultraviolet (UV) index. + * + *

In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you + * can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days). + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoTime frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are + * * `1` - Return forecast data for the next hour. Default value. + * * `12` - Return hourly forecast for next 12 hours. + * * `24` - Return hourly forecast for next 24 hours. + * * `72` - Return hourly forecast for next 72 hours (3 days). + * * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. + * * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             timestamp: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             hasPrecipitation: Boolean
+     *             isDaylight: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             relativeHumidity: Integer
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             precipitationProbability: Integer
+     *             rainProbability: Integer
+     *             snowProbability: Integer
+     *             iceProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getHourlyForecastWithResponseAsync(String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getHourlyForecast( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Hourly Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and + * 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, + * humidity, wind, precipitation, and ultraviolet (UV) index. + * + *

In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you + * can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days). + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoTime frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are + * * `1` - Return forecast data for the next hour. Default value. + * * `12` - Return hourly forecast for next 12 hours. + * * `24` - Return hourly forecast for next 24 hours. + * * `72` - Return hourly forecast for next 72 hours (3 days). + * * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. + * * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             timestamp: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             hasPrecipitation: Boolean
+     *             isDaylight: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             relativeHumidity: Integer
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             precipitationProbability: Integer
+     *             rainProbability: Integer
+     *             snowProbability: Integer
+     *             iceProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getHourlyForecastWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getHourlyForecast( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Hourly Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and + * 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, + * humidity, wind, precipitation, and ultraviolet (UV) index. + * + *

In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you + * can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days). + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoTime frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are + * * `1` - Return forecast data for the next hour. Default value. + * * `12` - Return hourly forecast for next 12 hours. + * * `24` - Return hourly forecast for next 24 hours. + * * `72` - Return hourly forecast for next 72 hours (3 days). + * * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. + * * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             timestamp: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             hasPrecipitation: Boolean
+     *             isDaylight: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             relativeHumidity: Integer
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             precipitationProbability: Integer
+     *             rainProbability: Integer
+     *             snowProbability: Integer
+     *             iceProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getHourlyForecastWithResponse(String format, RequestOptions requestOptions) { + return getHourlyForecastWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Minute Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. + * Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details + * such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation + * intensity value (dBZ). + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
intervalStringNoSpecifies time interval in minutes for the returned weather forecast. Supported values are + * * `1` - Retrieve forecast for 1-minute intervals. Returned by default. + * * `5` - Retrieve forecasts for 5-minute intervals. + * * `15` - Retrieve forecasts for 15-minute intervals.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         briefPhrase60: String
+     *         shortDescription: String
+     *         briefDescription: String
+     *         longPhrase: String
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *     }
+     *     intervalSummaries: [
+     *         {
+     *             startMinute: Integer
+     *             endMinute: Integer
+     *             totalMinutes: Integer
+     *             shortDescription: String
+     *             briefDescription: String
+     *             longPhrase: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         }
+     *     ]
+     *     intervals: [
+     *         {
+     *             startTime: String
+     *             minute: Integer
+     *             decibelRelativeToZ: Double
+     *             shortDescription: String
+     *             threshold: String
+     *             color: {
+     *                 red: Integer
+     *                 green: Integer
+     *                 blue: Integer
+     *                 hex: String
+     *             }
+     *             simplifiedColor: (recursive schema, see simplifiedColor above)
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getMinuteForecastWithResponseAsync(String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getMinuteForecast( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Minute Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. + * Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details + * such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation + * intensity value (dBZ). + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
intervalStringNoSpecifies time interval in minutes for the returned weather forecast. Supported values are + * * `1` - Retrieve forecast for 1-minute intervals. Returned by default. + * * `5` - Retrieve forecasts for 5-minute intervals. + * * `15` - Retrieve forecasts for 15-minute intervals.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         briefPhrase60: String
+     *         shortDescription: String
+     *         briefDescription: String
+     *         longPhrase: String
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *     }
+     *     intervalSummaries: [
+     *         {
+     *             startMinute: Integer
+     *             endMinute: Integer
+     *             totalMinutes: Integer
+     *             shortDescription: String
+     *             briefDescription: String
+     *             longPhrase: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         }
+     *     ]
+     *     intervals: [
+     *         {
+     *             startTime: String
+     *             minute: Integer
+     *             decibelRelativeToZ: Double
+     *             shortDescription: String
+     *             threshold: String
+     *             color: {
+     *                 red: Integer
+     *                 green: Integer
+     *                 blue: Integer
+     *                 hex: String
+     *             }
+     *             simplifiedColor: (recursive schema, see simplifiedColor above)
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getMinuteForecastWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getMinuteForecast( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Minute Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. + * Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details + * such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation + * intensity value (dBZ). + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
intervalStringNoSpecifies time interval in minutes for the returned weather forecast. Supported values are + * * `1` - Retrieve forecast for 1-minute intervals. Returned by default. + * * `5` - Retrieve forecasts for 5-minute intervals. + * * `15` - Retrieve forecasts for 15-minute intervals.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         briefPhrase60: String
+     *         shortDescription: String
+     *         briefDescription: String
+     *         longPhrase: String
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *     }
+     *     intervalSummaries: [
+     *         {
+     *             startMinute: Integer
+     *             endMinute: Integer
+     *             totalMinutes: Integer
+     *             shortDescription: String
+     *             briefDescription: String
+     *             longPhrase: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         }
+     *     ]
+     *     intervals: [
+     *         {
+     *             startTime: String
+     *             minute: Integer
+     *             decibelRelativeToZ: Double
+     *             shortDescription: String
+     *             threshold: String
+     *             color: {
+     *                 red: Integer
+     *                 green: Integer
+     *                 blue: Integer
+     *                 hex: String
+     *             }
+     *             simplifiedColor: (recursive schema, see simplifiedColor above)
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             cloudCover: Integer
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getMinuteForecastWithResponse(String format, RequestOptions requestOptions) { + return getMinuteForecastWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Quarter-Day Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given + * location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details + * such as temperature, humidity, wind, precipitation, and UV index are returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the quester-day forecast responses are returned. Supported values are: + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for next 10 days. + * * `15` - Return forecast data for the next 15 days.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             effectiveDate: String
+     *             quarter: String(0/1/2/3)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             phrase: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             relativeHumidity: Integer
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCover: Integer
+     *             hasPrecipitation: Boolean
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             precipitationIntensity: String
+     *             precipitationProbability: Integer
+     *             thunderstormProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getQuarterDayForecastWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getQuarterDayForecast( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Quarter-Day Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given + * location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details + * such as temperature, humidity, wind, precipitation, and UV index are returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the quester-day forecast responses are returned. Supported values are: + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for next 10 days. + * * `15` - Return forecast data for the next 15 days.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             effectiveDate: String
+     *             quarter: String(0/1/2/3)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             phrase: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             relativeHumidity: Integer
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCover: Integer
+     *             hasPrecipitation: Boolean
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             precipitationIntensity: String
+     *             precipitationProbability: Integer
+     *             thunderstormProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getQuarterDayForecastWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getQuarterDayForecast( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Quarter-Day Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given + * location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details + * such as temperature, humidity, wind, precipitation, and UV index are returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the quester-day forecast responses are returned. Supported values are: + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for next 10 days. + * * `15` - Return forecast data for the next 15 days.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             effectiveDate: String
+     *             quarter: String(0/1/2/3)
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             iconPhrase: String
+     *             phrase: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             relativeHumidity: Integer
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             visibility: (recursive schema, see visibility above)
+     *             cloudCover: Integer
+     *             hasPrecipitation: Boolean
+     *             precipitationType: String(Rain/Snow/Ice/Mix)
+     *             precipitationIntensity: String
+     *             precipitationProbability: Integer
+     *             thunderstormProbability: Integer
+     *             totalLiquid: (recursive schema, see totalLiquid above)
+     *             rain: (recursive schema, see rain above)
+     *             snow: (recursive schema, see snow above)
+     *             ice: (recursive schema, see ice above)
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getQuarterDayForecastWithResponse(String format, RequestOptions requestOptions) { + return getQuarterDayForecastWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Current Conditions** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature + * and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular + * location can be retrieved. The basic information returned with the response include details such as observation + * date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and + * temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoReturn full details for the current conditions. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.
durationStringNoTime frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: + * * `0` - Return the most current weather conditions. + * * `6` - Return weather conditions from past 6 hours. + * * `24` - Return weather conditions from past 24 hours.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             dateTime: String
+     *             description: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             hasPrecipitation: Boolean
+     *             isDaytime: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             relativeHumidity: Integer
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             visibility: (recursive schema, see visibility above)
+     *             obstructionsToVisibility: String
+     *             cloudCover: Integer
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             pressure: (recursive schema, see pressure above)
+     *             pressureTendency: {
+     *                 description: String
+     *                 code: String
+     *             }
+     *             pastTwentyFourHourTemperatureDeparture: (recursive schema, see pastTwentyFourHourTemperatureDeparture above)
+     *             apparentTemperature: (recursive schema, see apparentTemperature above)
+     *             windChillTemperature: (recursive schema, see windChillTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             precipitationSummary: {
+     *                 pastHour: (recursive schema, see pastHour above)
+     *                 pastThreeHours: (recursive schema, see pastThreeHours above)
+     *                 pastSixHours: (recursive schema, see pastSixHours above)
+     *                 pastNineHours: (recursive schema, see pastNineHours above)
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastEighteenHours: (recursive schema, see pastEighteenHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *             temperatureSummary: {
+     *                 pastSixHours: {
+     *                     minimum: (recursive schema, see minimum above)
+     *                     maximum: (recursive schema, see maximum above)
+     *                 }
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentConditionsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getCurrentConditions( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Current Conditions** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature + * and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular + * location can be retrieved. The basic information returned with the response include details such as observation + * date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and + * temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoReturn full details for the current conditions. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.
durationStringNoTime frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: + * * `0` - Return the most current weather conditions. + * * `6` - Return weather conditions from past 6 hours. + * * `24` - Return weather conditions from past 24 hours.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             dateTime: String
+     *             description: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             hasPrecipitation: Boolean
+     *             isDaytime: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             relativeHumidity: Integer
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             visibility: (recursive schema, see visibility above)
+     *             obstructionsToVisibility: String
+     *             cloudCover: Integer
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             pressure: (recursive schema, see pressure above)
+     *             pressureTendency: {
+     *                 description: String
+     *                 code: String
+     *             }
+     *             pastTwentyFourHourTemperatureDeparture: (recursive schema, see pastTwentyFourHourTemperatureDeparture above)
+     *             apparentTemperature: (recursive schema, see apparentTemperature above)
+     *             windChillTemperature: (recursive schema, see windChillTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             precipitationSummary: {
+     *                 pastHour: (recursive schema, see pastHour above)
+     *                 pastThreeHours: (recursive schema, see pastThreeHours above)
+     *                 pastSixHours: (recursive schema, see pastSixHours above)
+     *                 pastNineHours: (recursive schema, see pastNineHours above)
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastEighteenHours: (recursive schema, see pastEighteenHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *             temperatureSummary: {
+     *                 pastSixHours: {
+     *                     minimum: (recursive schema, see minimum above)
+     *                     maximum: (recursive schema, see maximum above)
+     *                 }
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentConditionsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getCurrentConditions( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Current Conditions** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature + * and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular + * location can be retrieved. The basic information returned with the response include details such as observation + * date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and + * temperature. Additional details such as RealFeel™ Temperature and UV index are also returned. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoReturn full details for the current conditions. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.
durationStringNoTime frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are: + * * `0` - Return the most current weather conditions. + * * `6` - Return weather conditions from past 6 hours. + * * `24` - Return weather conditions from past 24 hours.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             dateTime: String
+     *             description: String
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             hasPrecipitation: Boolean
+     *             isDaytime: Boolean
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             relativeHumidity: Integer
+     *             dewPoint: (recursive schema, see dewPoint above)
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             uvIndex: Integer
+     *             uvIndexDescription: String
+     *             visibility: (recursive schema, see visibility above)
+     *             obstructionsToVisibility: String
+     *             cloudCover: Integer
+     *             cloudCeiling: (recursive schema, see cloudCeiling above)
+     *             pressure: (recursive schema, see pressure above)
+     *             pressureTendency: {
+     *                 description: String
+     *                 code: String
+     *             }
+     *             pastTwentyFourHourTemperatureDeparture: (recursive schema, see pastTwentyFourHourTemperatureDeparture above)
+     *             apparentTemperature: (recursive schema, see apparentTemperature above)
+     *             windChillTemperature: (recursive schema, see windChillTemperature above)
+     *             wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
+     *             precipitationSummary: {
+     *                 pastHour: (recursive schema, see pastHour above)
+     *                 pastThreeHours: (recursive schema, see pastThreeHours above)
+     *                 pastSixHours: (recursive schema, see pastSixHours above)
+     *                 pastNineHours: (recursive schema, see pastNineHours above)
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastEighteenHours: (recursive schema, see pastEighteenHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *             temperatureSummary: {
+     *                 pastSixHours: {
+     *                     minimum: (recursive schema, see minimum above)
+     *                     maximum: (recursive schema, see maximum above)
+     *                 }
+     *                 pastTwelveHours: (recursive schema, see pastTwelveHours above)
+     *                 pastTwentyFourHours: (recursive schema, see pastTwentyFourHours above)
+     *             }
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getCurrentConditionsWithResponse(String format, RequestOptions requestOptions) { + return getCurrentConditionsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Daily Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, + * 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, + * precipitation, air quality, and UV index. + * + *

In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily + * forecast for the next 25 days, and 45 days. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the daily forecast responses are returned. Available values are + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for the next 10 days. + * * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. + * * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         startDate: String
+     *         endDate: String
+     *         severity: Integer
+     *         phrase: String
+     *         category: String
+     *     }
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             hoursOfSun: Float
+     *             meanTemperatureDeviation: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             airQuality: [
+     *                 {
+     *                     description: String
+     *                     value: Integer
+     *                     category: String
+     *                     categoryValue: Integer
+     *                     airQualityType: String
+     *                 }
+     *             ]
+     *             daytimeForecast: {
+     *                 iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *                 iconPhrase: String
+     *                 localSource: {
+     *                     id: Integer
+     *                     name: String
+     *                     weatherCode: String
+     *                 }
+     *                 hasPrecipitation: Boolean
+     *                 precipitationType: String(Rain/Snow/Ice/Mix)
+     *                 precipitationIntensity: String
+     *                 shortDescription: String
+     *                 longPhrase: String
+     *                 precipitationProbability: Integer
+     *                 thunderstormProbability: Integer
+     *                 rainProbability: Integer
+     *                 snowProbability: Integer
+     *                 iceProbability: Integer
+     *                 wind: {
+     *                     direction: {
+     *                         degrees: Integer
+     *                         description: String
+     *                     }
+     *                     speed: (recursive schema, see speed above)
+     *                 }
+     *                 windGust: (recursive schema, see windGust above)
+     *                 totalLiquid: (recursive schema, see totalLiquid above)
+     *                 rain: (recursive schema, see rain above)
+     *                 snow: (recursive schema, see snow above)
+     *                 ice: (recursive schema, see ice above)
+     *                 hoursOfPrecipitation: Float
+     *                 hoursOfRain: Float
+     *                 hoursOfSnow: Float
+     *                 hoursOfIce: Float
+     *                 cloudCover: Integer
+     *             }
+     *             nighttimeForecast: (recursive schema, see nighttimeForecast above)
+     *             sources: [
+     *                 String
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyForecastWithResponseAsync(String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getDailyForecast( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Daily Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, + * 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, + * precipitation, air quality, and UV index. + * + *

In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily + * forecast for the next 25 days, and 45 days. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the daily forecast responses are returned. Available values are + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for the next 10 days. + * * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. + * * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         startDate: String
+     *         endDate: String
+     *         severity: Integer
+     *         phrase: String
+     *         category: String
+     *     }
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             hoursOfSun: Float
+     *             meanTemperatureDeviation: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             airQuality: [
+     *                 {
+     *                     description: String
+     *                     value: Integer
+     *                     category: String
+     *                     categoryValue: Integer
+     *                     airQualityType: String
+     *                 }
+     *             ]
+     *             daytimeForecast: {
+     *                 iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *                 iconPhrase: String
+     *                 localSource: {
+     *                     id: Integer
+     *                     name: String
+     *                     weatherCode: String
+     *                 }
+     *                 hasPrecipitation: Boolean
+     *                 precipitationType: String(Rain/Snow/Ice/Mix)
+     *                 precipitationIntensity: String
+     *                 shortDescription: String
+     *                 longPhrase: String
+     *                 precipitationProbability: Integer
+     *                 thunderstormProbability: Integer
+     *                 rainProbability: Integer
+     *                 snowProbability: Integer
+     *                 iceProbability: Integer
+     *                 wind: {
+     *                     direction: {
+     *                         degrees: Integer
+     *                         description: String
+     *                     }
+     *                     speed: (recursive schema, see speed above)
+     *                 }
+     *                 windGust: (recursive schema, see windGust above)
+     *                 totalLiquid: (recursive schema, see totalLiquid above)
+     *                 rain: (recursive schema, see rain above)
+     *                 snow: (recursive schema, see snow above)
+     *                 ice: (recursive schema, see ice above)
+     *                 hoursOfPrecipitation: Float
+     *                 hoursOfRain: Float
+     *                 hoursOfSnow: Float
+     *                 hoursOfIce: Float
+     *                 cloudCover: Integer
+     *             }
+     *             nighttimeForecast: (recursive schema, see nighttimeForecast above)
+     *             sources: [
+     *                 String
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyForecastWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getDailyForecast( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Daily Forecast** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, + * 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, + * precipitation, air quality, and UV index. + * + *

In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily + * forecast for the next 25 days, and 45 days. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
durationStringNoSpecifies for how many days the daily forecast responses are returned. Available values are + * * `1` - Return forecast data for the next day. Returned by default. + * * `5` - Return forecast data for the next 5 days. + * * `10` - Return forecast data for the next 10 days. + * * `25` - Return forecast data for the next 25 days. Only available in S1 SKU. + * * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         startDate: String
+     *         endDate: String
+     *         severity: Integer
+     *         phrase: String
+     *         category: String
+     *     }
+     *     forecasts: [
+     *         {
+     *             dateTime: String
+     *             temperature: {
+     *                 minimum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             realFeelTemperature: (recursive schema, see realFeelTemperature above)
+     *             realFeelTemperatureShade: (recursive schema, see realFeelTemperatureShade above)
+     *             hoursOfSun: Float
+     *             meanTemperatureDeviation: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             airQuality: [
+     *                 {
+     *                     description: String
+     *                     value: Integer
+     *                     category: String
+     *                     categoryValue: Integer
+     *                     airQualityType: String
+     *                 }
+     *             ]
+     *             daytimeForecast: {
+     *                 iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *                 iconPhrase: String
+     *                 localSource: {
+     *                     id: Integer
+     *                     name: String
+     *                     weatherCode: String
+     *                 }
+     *                 hasPrecipitation: Boolean
+     *                 precipitationType: String(Rain/Snow/Ice/Mix)
+     *                 precipitationIntensity: String
+     *                 shortDescription: String
+     *                 longPhrase: String
+     *                 precipitationProbability: Integer
+     *                 thunderstormProbability: Integer
+     *                 rainProbability: Integer
+     *                 snowProbability: Integer
+     *                 iceProbability: Integer
+     *                 wind: {
+     *                     direction: {
+     *                         degrees: Integer
+     *                         description: String
+     *                     }
+     *                     speed: (recursive schema, see speed above)
+     *                 }
+     *                 windGust: (recursive schema, see windGust above)
+     *                 totalLiquid: (recursive schema, see totalLiquid above)
+     *                 rain: (recursive schema, see rain above)
+     *                 snow: (recursive schema, see snow above)
+     *                 ice: (recursive schema, see ice above)
+     *                 hoursOfPrecipitation: Float
+     *                 hoursOfRain: Float
+     *                 hoursOfSnow: Float
+     *                 hoursOfIce: Float
+     *                 cloudCover: Integer
+     *             }
+     *             nighttimeForecast: (recursive schema, see nighttimeForecast above)
+     *             sources: [
+     *                 String
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyForecastWithResponse(String format, RequestOptions requestOptions) { + return getDailyForecastWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Weather along route** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, + * weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a + * list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might + * be used to paint each portion of a route according to how safe it is for the driver. When submitting the + * waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or + * shortly after. Data is updated every five minutes. + * + *

The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows + * you to first request a route between an origin and a destination and use that as an input for Weather Along Route + * endpoint. + * + *

In addition, the service supports scenarios to generate weather notifications for waypoints that experience an + * increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy + * rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing + * the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for + * when to display the notification for a waypoint could be based, for example, on a + * [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the + * waypoint. + * + *

The API covers all regions of the planet except latitudes above Greenland and Antarctica. + * + *

Query Parameters + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesCoordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. + * A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where + * * `Latitude` - Latitude coordinate in decimal degrees. + * * `Longitude` - Longitude coordinate in decimal degrees. + * * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. + * * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. + * + * It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         hazards: {
+     *             maxHazardIndex: String(0/1/2/3/4)
+     *             details: [
+     *                 {
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     }
+     *     waypoints: [
+     *         {
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             shortDescription: String
+     *             isDaytime: Boolean
+     *             cloudCover: Integer
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             precipitation: {
+     *                 dbz: Double
+     *                 type: String
+     *             }
+     *             lightningCount: Integer
+     *             sunGlare: {
+     *                 calculatedVehicleHeading: Integer
+     *                 glareIndex: Integer
+     *             }
+     *             hazards: (recursive schema, see hazards above)
+     *             notifications: [
+     *                 {
+     *                     type: String
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Weather Along Route along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getWeatherAlongRouteWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getWeatherAlongRoute( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Weather along route** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, + * weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a + * list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might + * be used to paint each portion of a route according to how safe it is for the driver. When submitting the + * waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or + * shortly after. Data is updated every five minutes. + * + *

The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows + * you to first request a route between an origin and a destination and use that as an input for Weather Along Route + * endpoint. + * + *

In addition, the service supports scenarios to generate weather notifications for waypoints that experience an + * increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy + * rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing + * the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for + * when to display the notification for a waypoint could be based, for example, on a + * [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the + * waypoint. + * + *

The API covers all regions of the planet except latitudes above Greenland and Antarctica. + * + *

Query Parameters + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesCoordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. + * A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where + * * `Latitude` - Latitude coordinate in decimal degrees. + * * `Longitude` - Longitude coordinate in decimal degrees. + * * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. + * * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. + * + * It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         hazards: {
+     *             maxHazardIndex: String(0/1/2/3/4)
+     *             details: [
+     *                 {
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     }
+     *     waypoints: [
+     *         {
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             shortDescription: String
+     *             isDaytime: Boolean
+     *             cloudCover: Integer
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             precipitation: {
+     *                 dbz: Double
+     *                 type: String
+     *             }
+     *             lightningCount: Integer
+     *             sunGlare: {
+     *                 calculatedVehicleHeading: Integer
+     *                 glareIndex: Integer
+     *             }
+     *             hazards: (recursive schema, see hazards above)
+     *             notifications: [
+     *                 {
+     *                     type: String
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Weather Along Route along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getWeatherAlongRouteWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getWeatherAlongRoute( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Weather along route** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, + * weather hazard assessments, and notifications along a route described as a sequence of waypoints. This includes a + * list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might + * be used to paint each portion of a route according to how safe it is for the driver. When submitting the + * waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or + * shortly after. Data is updated every five minutes. + * + *

The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows + * you to first request a route between an origin and a destination and use that as an input for Weather Along Route + * endpoint. + * + *

In addition, the service supports scenarios to generate weather notifications for waypoints that experience an + * increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy + * rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing + * the end product to display a heavy rain notification before the driver reaches that waypoint. The trigger for + * when to display the notification for a waypoint could be based, for example, on a + * [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the + * waypoint. + * + *

The API covers all regions of the planet except latitudes above Greenland and Antarctica. + * + *

Query Parameters + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesCoordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. + * A waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where + * * `Latitude` - Latitude coordinate in decimal degrees. + * * `Longitude` - Longitude coordinate in decimal degrees. + * * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes. + * * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints. + * + * It is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     summary: {
+     *         iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *         hazards: {
+     *             maxHazardIndex: String(0/1/2/3/4)
+     *             details: [
+     *                 {
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     }
+     *     waypoints: [
+     *         {
+     *             iconCode: String(1/2/3/4/5/6/7/8/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/29/30/31/32/33/34/35/36/37/38/39/40/41/42/43/44)
+     *             shortDescription: String
+     *             isDaytime: Boolean
+     *             cloudCover: Integer
+     *             temperature: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             wind: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             windGust: (recursive schema, see windGust above)
+     *             precipitation: {
+     *                 dbz: Double
+     *                 type: String
+     *             }
+     *             lightningCount: Integer
+     *             sunGlare: {
+     *                 calculatedVehicleHeading: Integer
+     *                 glareIndex: Integer
+     *             }
+     *             hazards: (recursive schema, see hazards above)
+     *             notifications: [
+     *                 {
+     *                     type: String
+     *                     hazardIndex: String(0/1/2/3/4)
+     *                     hazardCode: String
+     *                     shortDescription: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Weather Along Route along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getWeatherAlongRouteWithResponse(String format, RequestOptions requestOptions) { + return getWeatherAlongRouteWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Severe Weather Alerts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Severe weather phenomenon can significantly impact our everyday life and business operations. For example, + * severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics + * companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of + * refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are + * available worldwide from both official Government Meteorological Agencies and leading global to + * regional weather alert providers. The service can return details such as alert type, category, level and detailed + * description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, + * heat waves or forest fires. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
detailsStringNoReturn full details for the severe weather alerts. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             countryCode: String
+     *             alertId: Integer
+     *             description: {
+     *                 description: String
+     *                 status: String
+     *             }
+     *             category: String
+     *             priority: Integer
+     *             classification: String
+     *             level: String
+     *             source: String
+     *             sourceId: Integer
+     *             disclaimer: String
+     *             alertDetails: [
+     *                 {
+     *                     name: String
+     *                     description: String
+     *                     startTime: String
+     *                     endTime: String
+     *                     latestStatus: {
+     *                         localized: String
+     *                         english: String(New/Extend/Cancel/Correct/Expire/Upgrade/Continue/Update)
+     *                     }
+     *                     details: String
+     *                     language: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Severe Weather Alerts call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getSevereWeatherAlertsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getSevereWeatherAlerts( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Severe Weather Alerts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Severe weather phenomenon can significantly impact our everyday life and business operations. For example, + * severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics + * companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of + * refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are + * available worldwide from both official Government Meteorological Agencies and leading global to + * regional weather alert providers. The service can return details such as alert type, category, level and detailed + * description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, + * heat waves or forest fires. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
detailsStringNoReturn full details for the severe weather alerts. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             countryCode: String
+     *             alertId: Integer
+     *             description: {
+     *                 description: String
+     *                 status: String
+     *             }
+     *             category: String
+     *             priority: Integer
+     *             classification: String
+     *             level: String
+     *             source: String
+     *             sourceId: Integer
+     *             disclaimer: String
+     *             alertDetails: [
+     *                 {
+     *                     name: String
+     *                     description: String
+     *                     startTime: String
+     *                     endTime: String
+     *                     latestStatus: {
+     *                         localized: String
+     *                         english: String(New/Extend/Cancel/Correct/Expire/Upgrade/Continue/Update)
+     *                     }
+     *                     details: String
+     *                     language: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Severe Weather Alerts call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getSevereWeatherAlertsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getSevereWeatherAlerts( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Severe Weather Alerts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Severe weather phenomenon can significantly impact our everyday life and business operations. For example, + * severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics + * companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of + * refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are + * available worldwide from both official Government Meteorological Agencies and leading global to + * regional weather alert providers. The service can return details such as alert type, category, level and detailed + * description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, + * heat waves or forest fires. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
detailsStringNoReturn full details for the severe weather alerts. Available values are + * * `true` - Returns full details. By default all details are returned. + * * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             countryCode: String
+     *             alertId: Integer
+     *             description: {
+     *                 description: String
+     *                 status: String
+     *             }
+     *             category: String
+     *             priority: Integer
+     *             classification: String
+     *             level: String
+     *             source: String
+     *             sourceId: Integer
+     *             disclaimer: String
+     *             alertDetails: [
+     *                 {
+     *                     name: String
+     *                     description: String
+     *                     startTime: String
+     *                     endTime: String
+     *                     latestStatus: {
+     *                         localized: String
+     *                         english: String(New/Extend/Cancel/Correct/Expire/Upgrade/Continue/Update)
+     *                     }
+     *                     details: String
+     *                     language: String
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Severe Weather Alerts call along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getSevereWeatherAlertsWithResponse(String format, RequestOptions requestOptions) { + return getSevereWeatherAlertsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Daily Indices** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

There may be times when you want to know if the weather conditions are optimal for a specific activity, for + * example, for outdoor construction, indoor activities, running or farming including soil moisture information. + * Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a + * health mobile application can notify users that today is good weather for running or for other outdoors + * activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on + * predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days + * starting from current day. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
durationStringNoSpecifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are + * * `1` - Return daily index data for the current day. Default value. + * * `5` - Return 5 days of daily index data starting from the current day. + * * `10` - Return 10 days of daily index data starting from the current day. + * * `15` - Return 15 days of daily index data starting from the current day.
indexIdStringNoNumeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
indexGroupIdStringNoNumeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             indexName: String
+     *             indexId: Integer
+     *             dateTime: String
+     *             value: Float
+     *             categoryDescription: String
+     *             categoryValue: Integer
+     *             isAscending: Boolean
+     *             description: String
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Indices call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyIndicesWithResponseAsync(String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getDailyIndices( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Daily Indices** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

There may be times when you want to know if the weather conditions are optimal for a specific activity, for + * example, for outdoor construction, indoor activities, running or farming including soil moisture information. + * Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a + * health mobile application can notify users that today is good weather for running or for other outdoors + * activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on + * predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days + * starting from current day. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
durationStringNoSpecifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are + * * `1` - Return daily index data for the current day. Default value. + * * `5` - Return 5 days of daily index data starting from the current day. + * * `10` - Return 10 days of daily index data starting from the current day. + * * `15` - Return 15 days of daily index data starting from the current day.
indexIdStringNoNumeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
indexGroupIdStringNoNumeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             indexName: String
+     *             indexId: Integer
+     *             dateTime: String
+     *             value: Float
+     *             categoryDescription: String
+     *             categoryValue: Integer
+     *             isAscending: Boolean
+     *             description: String
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Indices call along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyIndicesWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getDailyIndices( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Daily Indices** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

There may be times when you want to know if the weather conditions are optimal for a specific activity, for + * example, for outdoor construction, indoor activities, running or farming including soil moisture information. + * Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a + * health mobile application can notify users that today is good weather for running or for other outdoors + * activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on + * predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days + * starting from current day. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
durationStringNoSpecifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are + * * `1` - Return daily index data for the current day. Default value. + * * `5` - Return 5 days of daily index data starting from the current day. + * * `10` - Return 10 days of daily index data starting from the current day. + * * `15` - Return 15 days of daily index data starting from the current day.
indexIdStringNoNumeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
indexGroupIdStringNoNumeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     results: [
+     *         {
+     *             indexName: String
+     *             indexId: Integer
+     *             dateTime: String
+     *             value: Float
+     *             categoryDescription: String
+     *             categoryValue: Integer
+     *             isAscending: Boolean
+     *             description: String
+     *         }
+     *     ]
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Indices call along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyIndicesWithResponse(String format, RequestOptions requestOptions) { + return getDailyIndicesWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Tropical Storm Active** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get all government-issued active tropical storms. Information about the tropical storms includes, government + * ID, basin ID, year of origin, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     activeStorms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return all government-issued active storms along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormActiveWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getTropicalStormActive( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Tropical Storm Active** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get all government-issued active tropical storms. Information about the tropical storms includes, government + * ID, basin ID, year of origin, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     activeStorms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return all government-issued active storms along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormActiveWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getTropicalStormActive( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Tropical Storm Active** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get all government-issued active tropical storms. Information about the tropical storms includes, government + * ID, basin ID, year of origin, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     activeStorms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return all government-issued active storms along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormActiveWithResponse(String format, RequestOptions requestOptions) { + return getTropicalStormActiveWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Tropical Storm Search** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Search government-issued tropical storms by year, basin ID, and government ID. Information about the tropical + * storms includes, government ID, basin ID, status, year, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringNoBasin identifier
govIdStringNoGovernment storm Id
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     storms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isRetired: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return search government-issued storms along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> searchTropicalStormWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.searchTropicalStorm( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Tropical Storm Search** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Search government-issued tropical storms by year, basin ID, and government ID. Information about the tropical + * storms includes, government ID, basin ID, status, year, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringNoBasin identifier
govIdStringNoGovernment storm Id
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     storms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isRetired: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return search government-issued storms along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> searchTropicalStormWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.searchTropicalStorm( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Tropical Storm Search** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Search government-issued tropical storms by year, basin ID, and government ID. Information about the tropical + * storms includes, government ID, basin ID, status, year, name and if it is subtropical. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringNoBasin identifier
govIdStringNoGovernment storm Id
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     storms: [
+     *         {
+     *             year: String
+     *             basinId: String(AL/EP/SI/NI/CP/NP/SP)
+     *             name: String
+     *             isActive: Boolean
+     *             isRetired: Boolean
+     *             isSubtropical: Boolean
+     *             govId: Integer
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return search government-issued storms along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response searchTropicalStormWithResponse(String format, RequestOptions requestOptions) { + return searchTropicalStormWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Tropical Storm Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get individual government-issued tropical storm forecasts. Information about the forecasted tropical storms + * includes, location, status, date the forecast was created, window, wind speed and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
windowGeometryStringNoWhen true, window geometry data (geoJSON) is included in the response
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormForecasts: [
+     *         {
+     *             timestamp: String
+     *             initializedTimestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             status: String
+     *             weatherWindow: {
+     *                 topLeft: (recursive schema, see topLeft above)
+     *                 bottomRight: (recursive schema, see bottomRight above)
+     *                 beginTimestamp: String
+     *                 endTimestamp: String
+     *                 beginStatus: String
+     *                 endStatus: String
+     *                 geometry: {
+     *                 }
+     *             }
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: (recursive schema, see radiiGeometry above)
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the list of Government-issued forecasts along with {@link Response} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormForecastWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getTropicalStormForecast( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Tropical Storm Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get individual government-issued tropical storm forecasts. Information about the forecasted tropical storms + * includes, location, status, date the forecast was created, window, wind speed and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
windowGeometryStringNoWhen true, window geometry data (geoJSON) is included in the response
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormForecasts: [
+     *         {
+     *             timestamp: String
+     *             initializedTimestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             status: String
+     *             weatherWindow: {
+     *                 topLeft: (recursive schema, see topLeft above)
+     *                 bottomRight: (recursive schema, see bottomRight above)
+     *                 beginTimestamp: String
+     *                 endTimestamp: String
+     *                 beginStatus: String
+     *                 endStatus: String
+     *                 geometry: {
+     *                 }
+     *             }
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: (recursive schema, see radiiGeometry above)
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the list of Government-issued forecasts along with {@link Response} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormForecastWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getTropicalStormForecast( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Tropical Storm Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get individual government-issued tropical storm forecasts. Information about the forecasted tropical storms + * includes, location, status, date the forecast was created, window, wind speed and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
windowGeometryStringNoWhen true, window geometry data (geoJSON) is included in the response
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormForecasts: [
+     *         {
+     *             timestamp: String
+     *             initializedTimestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             status: String
+     *             weatherWindow: {
+     *                 topLeft: (recursive schema, see topLeft above)
+     *                 bottomRight: (recursive schema, see bottomRight above)
+     *                 beginTimestamp: String
+     *                 endTimestamp: String
+     *                 beginStatus: String
+     *                 endStatus: String
+     *                 geometry: {
+     *                 }
+     *             }
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: (recursive schema, see radiiGeometry above)
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the list of Government-issued forecasts along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormForecastWithResponse(String format, RequestOptions requestOptions) { + return getTropicalStormForecastWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Tropical Storm Locations** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get location of individual government-issued tropical storms. Information about the tropical storms includes, + * location coordinates, geometry, basin ID, date, wind details and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
currentStringNoWhen true, return the current storm location
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormLocations: [
+     *         {
+     *             timestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             minimumPressure: (recursive schema, see minimumPressure above)
+     *             movement: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             status: String
+     *             isSubtropical: Boolean
+     *             hasTropicalPotential: Boolean
+     *             isPostTropical: Boolean
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: {
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return locations for an individual government-issued storm along with {@link Response} on successful completion + * of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormLocationsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getTropicalStormLocations( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Tropical Storm Locations** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get location of individual government-issued tropical storms. Information about the tropical storms includes, + * location coordinates, geometry, basin ID, date, wind details and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
currentStringNoWhen true, return the current storm location
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormLocations: [
+     *         {
+     *             timestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             minimumPressure: (recursive schema, see minimumPressure above)
+     *             movement: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             status: String
+     *             isSubtropical: Boolean
+     *             hasTropicalPotential: Boolean
+     *             isPostTropical: Boolean
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: {
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return locations for an individual government-issued storm along with {@link Response} on successful completion + * of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getTropicalStormLocationsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getTropicalStormLocations( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Tropical Storm Locations** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get location of individual government-issued tropical storms. Information about the tropical storms includes, + * location coordinates, geometry, basin ID, date, wind details and wind radii. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
yearintYesYear of the cyclone(s)
basinIdStringYesBasin identifier
govIdintYesGovernment storm Id
detailsStringNoWhen true, wind radii summary data is included in the response
radiiGeometryStringNoWhen true, wind radii summary data and geoJSON details are included in the response
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
currentStringNoWhen true, return the current storm location
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     stormLocations: [
+     *         {
+     *             timestamp: String
+     *             coordinates: {
+     *                 latitude: Double
+     *                 longitude: Double
+     *             }
+     *             maxWindGust: {
+     *                 value: Float
+     *                 unitLabel: String
+     *                 unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *             }
+     *             sustainedWind: (recursive schema, see sustainedWind above)
+     *             minimumPressure: (recursive schema, see minimumPressure above)
+     *             movement: {
+     *                 direction: {
+     *                     degrees: Integer
+     *                     description: String
+     *                 }
+     *                 speed: (recursive schema, see speed above)
+     *             }
+     *             status: String
+     *             isSubtropical: Boolean
+     *             hasTropicalPotential: Boolean
+     *             isPostTropical: Boolean
+     *             windRadiiSummary: [
+     *                 {
+     *                     timestamp: String
+     *                     windSpeed: (recursive schema, see windSpeed above)
+     *                     radiusSectorData: [
+     *                         {
+     *                             beginBearing: Double
+     *                             endBearing: Double
+     *                             radius: Double
+     *                         }
+     *                     ]
+     *                     radiiGeometry: {
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return locations for an individual government-issued storm along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getTropicalStormLocationsWithResponse(String format, RequestOptions requestOptions) { + return getTropicalStormLocationsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Current Air Quality** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for current air quality. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentAirQualityWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getCurrentAirQuality( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Current Air Quality** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for current air quality. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getCurrentAirQualityWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getCurrentAirQuality( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Current Air Quality** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for current air quality. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getCurrentAirQualityWithResponse(String format, RequestOptions requestOptions) { + return getCurrentAirQualityWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Air Quality Daily Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status of forecasted daily air + * quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Air Quality Forecast call along with {@link Response} + * on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityDailyForecastsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getAirQualityDailyForecasts( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Air Quality Daily Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status of forecasted daily air + * quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Air Quality Forecast call along with {@link Response} + * on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityDailyForecastsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getAirQualityDailyForecasts( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Air Quality Daily Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status of forecasted daily air + * quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days. + * Information includes, pollution levels, air quality index values, the dominant pollutant, and a brief statement + * summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many days from now we would like to know about the air quality. Available values are 1, 2, 3, 4, 5, 6, and 7. Default value is 1.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Daily Air Quality Forecast call along with {@link + * Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getAirQualityDailyForecastsWithResponse(String format, RequestOptions requestOptions) { + return getAirQualityDailyForecastsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Air Quality Hourly Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for forecasted upcoming + * hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans + * of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the + * dominant pollutant, and a brief statement summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityHourlyForecastsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getAirQualityHourlyForecasts( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Air Quality Hourly Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for forecasted upcoming + * hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans + * of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the + * dominant pollutant, and a brief statement summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getAirQualityHourlyForecastsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getAirQualityHourlyForecasts( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Air Quality Hourly Forecasts** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get detailed information about the concentration of pollutants and overall status for forecasted upcoming + * hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans + * of 1, 12, 24, 48, 72, and 96 hours. Information includes, pollution levels, air quality index values, the + * dominant pollutant, and a brief statement summarizing risk level and suggested precautions. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
languageStringNoLanguage in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. + * + * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
durationStringNoSpecifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
pollutantsStringNoBoolean value that returns detailed information about each pollutant. By default is True.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     airQualityResults: [
+     *         {
+     *             timestamp: String
+     *             index: Float
+     *             globalIndex: Float
+     *             dominantPollutant: String(Carbon Monoxide/Nitrogen Dioxide/Ozone/Particulate Matter 2.5/Particulate Matter 10/Sulfur Dioxide)
+     *             category: String
+     *             categoryColor: String
+     *             description: String
+     *             pollutants: [
+     *                 {
+     *                     type: String(CO/NO2/O3/PM2.5/PM10/SO2)
+     *                     name: String
+     *                     index: Float
+     *                     globalIndex: Float
+     *                     concentration: {
+     *                         value: Float
+     *                         unitLabel: String
+     *                         unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                     }
+     *                 }
+     *             ]
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return this object is returned from a successful Get Air Quality call along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getAirQualityHourlyForecastsWithResponse(String format, RequestOptions requestOptions) { + return getAirQualityHourlyForecastsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Daily Historical Actuals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, + * precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate + * location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, + * historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalActuals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *             snowfall: (recursive schema, see snowfall above)
+     *             snowDepth: (recursive schema, see snowDepth above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalActualsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getDailyHistoricalActuals( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Daily Historical Actuals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, + * precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate + * location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, + * historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalActuals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *             snowfall: (recursive schema, see snowfall above)
+     *             snowDepth: (recursive schema, see snowDepth above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalActualsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getDailyHistoricalActuals( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Daily Historical Actuals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, + * precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate + * location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, + * historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalActuals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *             snowfall: (recursive schema, see snowfall above)
+     *             snowDepth: (recursive schema, see snowDepth above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalActualsWithResponse(String format, RequestOptions requestOptions) { + return getDailyHistoricalActualsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Daily Historical Records** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Records service returns climatology data such as past daily record temperatures, + * precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. + * Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalRecords: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unit: String
+     *                     unitType: Integer
+     *                     year: Integer
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *             }
+     *             precipitation: {
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             snowfall: (recursive schema, see snowfall above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalRecordsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getDailyHistoricalRecords( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Daily Historical Records** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Records service returns climatology data such as past daily record temperatures, + * precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. + * Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalRecords: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unit: String
+     *                     unitType: Integer
+     *                     year: Integer
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *             }
+     *             precipitation: {
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             snowfall: (recursive schema, see snowfall above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalRecordsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getDailyHistoricalRecords( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Daily Historical Records** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Records service returns climatology data such as past daily record temperatures, + * precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. + * Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalRecords: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unit: String
+     *                     unitType: Integer
+     *                     year: Integer
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *             }
+     *             precipitation: {
+     *                 maximum: (recursive schema, see maximum above)
+     *             }
+     *             snowfall: (recursive schema, see snowfall above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalRecordsWithResponse(String format, RequestOptions requestOptions) { + return getDailyHistoricalRecordsWithResponseAsync(format, requestOptions).block(); + } + + /** + * **Get Daily Historical Normals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Normals service returns climatology data such as past daily normal temperatures, + * precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are + * a 30-year average for temperatures and precipitation for a specific location. As is standard practice in + * climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will + * reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, + * depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalNormals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalNormalsWithResponseAsync( + String format, RequestOptions requestOptions) { + return FluxUtil.withContext( + context -> + service.getDailyHistoricalNormals( + this.client.getHost(), + this.client.getServiceVersion().getVersion(), + format, + requestOptions, + context)); + } + + /** + * **Get Daily Historical Normals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Normals service returns climatology data such as past daily normal temperatures, + * precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are + * a 30-year average for temperatures and precipitation for a specific location. As is standard practice in + * climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will + * reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, + * depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalNormals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono> getDailyHistoricalNormalsWithResponseAsync( + String format, RequestOptions requestOptions, Context context) { + return service.getDailyHistoricalNormals( + this.client.getHost(), this.client.getServiceVersion().getVersion(), format, requestOptions, context); + } + + /** + * **Get Daily Historical Normals** + * + *

**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + * + *

Get Daily Historical Normals service returns climatology data such as past daily normal temperatures, + * precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are + * a 30-year average for temperatures and precipitation for a specific location. As is standard practice in + * climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will + * reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, + * depending on the location. + * + *

Query Parameters + * + * + * + * + * + * + * + * + * + *
Query Parameters
NameTypeRequiredDescription
api-versionStringYesApi Version
queryStringYesThe applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
startDateStringYesStart date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
endDateStringYesEnd date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).
unitStringNoSpecifies to return the data in either metric units or imperial units. Default value is metric.
+ * + *

Header Parameters + * + * + * + * + * + *
Header Parameters
NameTypeRequiredDescription
x-ms-client-idStringNoSpecifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
+ * + *

Response Body Schema + * + * 

{@code
+     * {
+     *     historicalNormals: [
+     *         {
+     *             timestamp: String
+     *             temperature: {
+     *                 maximum: {
+     *                     value: Float
+     *                     unitLabel: String
+     *                     unitType: String(0/1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/21/22/31)
+     *                 }
+     *                 minimum: (recursive schema, see minimum above)
+     *                 average: (recursive schema, see average above)
+     *             }
+     *             degreeDaySummary: {
+     *                 heating: (recursive schema, see heating above)
+     *                 cooling: (recursive schema, see cooling above)
+     *             }
+     *             precipitation: (recursive schema, see precipitation above)
+     *         }
+     *     ]
+     *     nextLink: String
+     * }
+     * }
+ * + * @param format Desired format of the response. Only `json` format is supported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @return the response body along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response getDailyHistoricalNormalsWithResponse(String format, RequestOptions requestOptions) { + return getDailyHistoricalNormalsWithResponseAsync(format, requestOptions).block(); + } +} diff --git a/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/package-info.java b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/package-info.java new file mode 100644 index 000000000000..28e5e831d80e --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/com/azure/maps/weather/package-info.java @@ -0,0 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +/** Package containing the classes for AzureMapsWeatherService. null. */ +package com.azure.maps.weather; diff --git a/sdk/maps/azure-maps-weather/src/main/java/module-info.java b/sdk/maps/azure-maps-weather/src/main/java/module-info.java new file mode 100644 index 000000000000..ac7852b6ecde --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/java/module-info.java @@ -0,0 +1,9 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +module com.azure.maps.weather { + requires transitive com.azure.core; + + exports com.azure.maps.weather; +} diff --git a/sdk/maps/azure-maps-weather/src/main/resources/azure-maps-weather.properties b/sdk/maps/azure-maps-weather/src/main/resources/azure-maps-weather.properties new file mode 100644 index 000000000000..ca812989b4f2 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/main/resources/azure-maps-weather.properties @@ -0,0 +1,2 @@ +name=${project.artifactId} +version=${project.version} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/ReadmeSamples.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/ReadmeSamples.java new file mode 100644 index 000000000000..7b231915cb31 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/ReadmeSamples.java @@ -0,0 +1,12 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +public final class ReadmeSamples { + public void readmeSamples() { + // BEGIN: com.azure.maps.weather.readme + // END: com.azure.maps.weather.readme + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetCurrentAirQuality.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetCurrentAirQuality.java new file mode 100644 index 000000000000..f861ae54cc73 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetCurrentAirQuality.java @@ -0,0 +1,25 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetCurrentAirQuality { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("query", "47.632346,-122.13887"); + Response response = client.getCurrentAirQualityWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetDailyAirQualityForecasts.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetDailyAirQualityForecasts.java new file mode 100644 index 000000000000..81a183995bcc --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetDailyAirQualityForecasts.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetDailyAirQualityForecasts { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("duration", "3"); + requestOptions.addQueryParam("query", "47.632346,-122.13887"); + Response response = client.getAirQualityDailyForecastsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetHourlyAirQualityForecasts.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetHourlyAirQualityForecasts.java new file mode 100644 index 000000000000..0e8079d9a526 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetHourlyAirQualityForecasts.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetHourlyAirQualityForecasts { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("duration", "12"); + requestOptions.addQueryParam("query", "47.632346,-122.138874"); + Response response = client.getAirQualityHourlyForecastsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormActive.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormActive.java new file mode 100644 index 000000000000..e363a1a279ff --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormActive.java @@ -0,0 +1,24 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormActive { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + Response response = client.getTropicalStormActiveWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormCurrentLocation.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormCurrentLocation.java new file mode 100644 index 000000000000..fdb4ddc6dcb5 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormCurrentLocation.java @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormCurrentLocation { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("current", "true"); + requestOptions.addQueryParam("year", 2021); + requestOptions.addQueryParam("govId", 2); + requestOptions.addQueryParam("basinId", "NP"); + Response response = client.getTropicalStormLocationsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormForecasts.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormForecasts.java new file mode 100644 index 000000000000..c77de4eddb3c --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormForecasts.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormForecasts { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("basinId", "NP"); + requestOptions.addQueryParam("year", 2021); + requestOptions.addQueryParam("govId", 2); + Response response = client.getTropicalStormForecastWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormLocations.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormLocations.java new file mode 100644 index 000000000000..b62537625fce --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormLocations.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormLocations { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("basinId", "NP"); + requestOptions.addQueryParam("year", 2021); + requestOptions.addQueryParam("govId", 1); + Response response = client.getTropicalStormLocationsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearch.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearch.java new file mode 100644 index 000000000000..1a0d2921a9e9 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearch.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormSearch { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("basinId", "AL"); + requestOptions.addQueryParam("year", 2021); + Response response = client.searchTropicalStormWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearchWithThreeProperties.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearchWithThreeProperties.java new file mode 100644 index 000000000000..f3543de706d6 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/GetTropicalStormSearchWithThreeProperties.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class GetTropicalStormSearchWithThreeProperties { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("basinId", "AL"); + requestOptions.addQueryParam("year", 2021); + requestOptions.addQueryParam("govId", "1"); + Response response = client.searchTropicalStormWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalActualsRequest.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalActualsRequest.java new file mode 100644 index 000000000000..bd25f02776a3 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalActualsRequest.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfulDailyHistoricalActualsRequest { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("endDate", "2012-01-22"); + requestOptions.addQueryParam("startDate", "2012-01-20"); + requestOptions.addQueryParam("query", "40.78,-77.89"); + Response response = client.getDailyHistoricalActualsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalNormalsRequest.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalNormalsRequest.java new file mode 100644 index 000000000000..b67ec53790a0 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalNormalsRequest.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfulDailyHistoricalNormalsRequest { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("endDate", "2012-01-22"); + requestOptions.addQueryParam("startDate", "2012-01-20"); + requestOptions.addQueryParam("query", "39.952583,-75.165222"); + Response response = client.getDailyHistoricalNormalsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalRecordsRequest.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalRecordsRequest.java new file mode 100644 index 000000000000..bc20bfdbd77f --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfulDailyHistoricalRecordsRequest.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfulDailyHistoricalRecordsRequest { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("endDate", "2012-01-22"); + requestOptions.addQueryParam("startDate", "2012-01-20"); + requestOptions.addQueryParam("query", "39.952583,-75.165222"); + Response response = client.getDailyHistoricalRecordsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDailyIndicesValuesFromCurrentDay.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDailyIndicesValuesFromCurrentDay.java new file mode 100644 index 000000000000..16a620d45ef7 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDailyIndicesValuesFromCurrentDay.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDailyIndicesValuesFromCurrentDay { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("indexGroupId", "11"); + requestOptions.addQueryParam("query", "43.84745,-79.37849"); + Response response = client.getDailyIndicesWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedCurrentWeatherConditionsForAGivenCoordinateLocation.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedCurrentWeatherConditionsForAGivenCoordinateLocation.java new file mode 100644 index 000000000000..3a0ceb1db271 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedCurrentWeatherConditionsForAGivenCoordinateLocation.java @@ -0,0 +1,25 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDetailedCurrentWeatherConditionsForAGivenCoordinateLocation { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("query", "47.641268,-122.125679"); + Response response = client.getCurrentConditionsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedDailyWeatherForecastForAGivenCoordinateLocation.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedDailyWeatherForecastForAGivenCoordinateLocation.java new file mode 100644 index 000000000000..4269c2a7e5a3 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedDailyWeatherForecastForAGivenCoordinateLocation.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDetailedDailyWeatherForecastForAGivenCoordinateLocation { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("duration", "5"); + requestOptions.addQueryParam("query", "62.6490341,30.0734812"); + Response response = client.getDailyForecastWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherCastsAlongARouteDescribedAsASequenceOfWaypoints.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherCastsAlongARouteDescribedAsASequenceOfWaypoints.java new file mode 100644 index 000000000000..e871c50076f5 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherCastsAlongARouteDescribedAsASequenceOfWaypoints.java @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDetailedWeatherCastsAlongARouteDescribedAsASequenceOfWaypoints { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam( + "query", + "38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60"); + Response response = client.getWeatherAlongRouteWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByAGivenLocation.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByAGivenLocation.java new file mode 100644 index 000000000000..2ccf279543c2 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByAGivenLocation.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDetailedWeatherForecastByAGivenLocation { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("duration", "1"); + requestOptions.addQueryParam("query", "47.632346,-122.138874"); + Response response = client.getQuarterDayForecastWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByTheHour.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByTheHour.java new file mode 100644 index 000000000000..61a99fd19e4c --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveDetailedWeatherForecastByTheHour.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveDetailedWeatherForecastByTheHour { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("duration", "12"); + requestOptions.addQueryParam("query", "47.632346,-122.138874"); + Response response = client.getHourlyForecastWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveMinuteByMinuteForecastsForAGivenLocation.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveMinuteByMinuteForecastsForAGivenLocation.java new file mode 100644 index 000000000000..e947bf529302 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveMinuteByMinuteForecastsForAGivenLocation.java @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveMinuteByMinuteForecastsForAGivenLocation { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("interval", "15"); + requestOptions.addQueryParam("query", "47.632346,-122.138874"); + Response response = client.getMinuteForecastWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveSevereWeatherAlerts.java b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveSevereWeatherAlerts.java new file mode 100644 index 000000000000..a788bb76e580 --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/samples/java/com/azure/maps/weather/generated/SuccessfullyRetrieveSevereWeatherAlerts.java @@ -0,0 +1,25 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather.generated; + +import com.azure.core.http.rest.RequestOptions; +import com.azure.core.http.rest.Response; +import com.azure.core.util.BinaryData; +import com.azure.identity.DefaultAzureCredentialBuilder; +import com.azure.maps.weather.AzureMapsWeatherServiceClient; +import com.azure.maps.weather.AzureMapsWeatherServiceClientBuilder; + +public class SuccessfullyRetrieveSevereWeatherAlerts { + public static void main(String[] args) { + AzureMapsWeatherServiceClient client = + new AzureMapsWeatherServiceClientBuilder() + .credential(new DefaultAzureCredentialBuilder().build()) + .host("https://atlas.microsoft.com") + .buildClient(); + RequestOptions requestOptions = new RequestOptions(); + requestOptions.addQueryParam("query", "48.057,-81.091"); + Response response = client.getSevereWeatherAlertsWithResponse("json", requestOptions); + } +} diff --git a/sdk/maps/azure-maps-weather/src/test/java/com/azure/maps/weather/ClientTests.java b/sdk/maps/azure-maps-weather/src/test/java/com/azure/maps/weather/ClientTests.java new file mode 100644 index 000000000000..412e94c522df --- /dev/null +++ b/sdk/maps/azure-maps-weather/src/test/java/com/azure/maps/weather/ClientTests.java @@ -0,0 +1,50 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. +// Code generated by Microsoft (R) AutoRest Code Generator. + +package com.azure.maps.weather; + +import com.azure.core.credential.AccessToken; +import com.azure.core.http.HttpClient; +import com.azure.core.http.policy.HttpLogDetailLevel; +import com.azure.core.http.policy.HttpLogOptions; +import com.azure.core.test.TestBase; +import com.azure.core.test.TestMode; +import com.azure.core.test.annotation.DoNotRecord; +import com.azure.core.util.Configuration; +import com.azure.identity.DefaultAzureCredentialBuilder; +import java.time.OffsetDateTime; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import reactor.core.publisher.Mono; + +public final class ClientTests extends TestBase { + private AzureMapsWeatherServiceClient azureMapsWeatherServiceClient; + + @BeforeEach + public void setup() { + AzureMapsWeatherServiceClientBuilder azureMapsWeatherServiceClientbuilder = + new AzureMapsWeatherServiceClientBuilder() + .host(Configuration.getGlobalConfiguration().get("HOST", "https://atlas.microsoft.com")) + .httpClient(HttpClient.createDefault()) + .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BASIC)); + if (getTestMode() == TestMode.PLAYBACK) { + azureMapsWeatherServiceClientbuilder + .httpClient(interceptorManager.getPlaybackClient()) + .credential(request -> Mono.just(new AccessToken("this_is_a_token", OffsetDateTime.MAX))); + } else if (getTestMode() == TestMode.RECORD) { + azureMapsWeatherServiceClientbuilder + .addPolicy(interceptorManager.getRecordPolicy()) + .credential(new DefaultAzureCredentialBuilder().build()); + } else if (getTestMode() == TestMode.LIVE) { + azureMapsWeatherServiceClientbuilder.credential(new DefaultAzureCredentialBuilder().build()); + } + azureMapsWeatherServiceClient = azureMapsWeatherServiceClientbuilder.buildClient(); + } + + @Test + @DoNotRecord(skipInPlayback = true) + public void testClient() { + // use the builder to create client + } +} diff --git a/sdk/maps/azure-maps-weather/swagger/README_SPEC.md b/sdk/maps/azure-maps-weather/swagger/README_SPEC.md new file mode 100644 index 000000000000..02b4ae2986ad --- /dev/null +++ b/sdk/maps/azure-maps-weather/swagger/README_SPEC.md @@ -0,0 +1,25 @@ +## Generate autorest code + +```yaml +input-files: +- /home/vsts/work/1/s/azure-rest-api-specs/specification/maps/data-plane/Weather/stable/1.1/weather.json +output-folder: ../ +java: true +regenerate-pom: false +partial-update: true +generate-sync-async-clients: true +generate-client-as-impl: true +generate-client-interfaces: false +generate-builder-per-client: true +add-context-parameter: true +artifact-id: azure-maps-weather +low-level-client: true +sync-methods: all +generate-samples: true +license-header: MICROSOFT_MIT_SMALL +namespace: com.azure.maps.weather +context-client-method-parameter: true +azure-arm: false +service-versions: +- '1.1' +```