public final class WeatherBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
com.azure.core.experimental.http.DynamicRequest |
createDataDeleteJob(String jobId)
Create a weather data delete job.
|
com.azure.core.experimental.http.DynamicRequest |
createDataIngestionJob(String jobId)
Create a weather data ingestion job.
|
com.azure.core.experimental.http.DynamicRequest |
getDataDeleteJobDetails(String jobId)
Get weather data delete job.
|
com.azure.core.experimental.http.DynamicRequest |
getDataIngestionJobDetails(String jobId)
Get weather ingestion job.
|
com.azure.core.experimental.http.DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
com.azure.core.experimental.http.DynamicRequest |
list(String farmerId,
String boundaryId,
String extensionId,
String weatherDataType,
String granularity)
Returns a paginated list of weather data.
|
com.azure.core.experimental.http.DynamicRequest |
listNext(String nextLink)
Get the next page of items.
|
public com.azure.core.experimental.http.DynamicRequest list(String farmerId, String boundaryId, String extensionId, String weatherDataType, String granularity)
Optional Query Parameters
Name | Type | Description |
---|---|---|
startDateTime | OffsetDateTime | Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
endDateTime | OffsetDateTime | Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. |
maxPageSize | Integer | Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. |
skipToken | String | Skip token for getting next set of results. |
Response Body Schema
{
value: [
{
farmerId: String
boundaryId: String
extensionId: String
location: {
latitude: double
longitude: double
}
dateTime: OffsetDateTime
unitSystemCode: String
extensionVersion: String
weatherDataType: String
granularity: String
cloudCover: {
unit: String
value: Double
}
dewPoint: (recursive schema, see dewPoint above)
growingDegreeDay: (recursive schema, see growingDegreeDay above)
precipitation: (recursive schema, see precipitation above)
pressure: (recursive schema, see pressure above)
relativeHumidity: (recursive schema, see relativeHumidity above)
soilMoisture: (recursive schema, see soilMoisture above)
soilTemperature: (recursive schema, see soilTemperature above)
temperature: (recursive schema, see temperature above)
visibility: (recursive schema, see visibility above)
wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
windChill: (recursive schema, see windChill above)
windDirection: (recursive schema, see windDirection above)
windGust: (recursive schema, see windGust above)
windSpeed: (recursive schema, see windSpeed above)
id: String
eTag: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
farmerId
- Farmer ID.boundaryId
- Boundary ID.extensionId
- ID of the weather extension.weatherDataType
- Type of weather data (forecast/historical).granularity
- Granularity of weather data (daily/hourly).public com.azure.core.experimental.http.DynamicRequest getDataIngestionJobDetails(String jobId)
Response Body Schema
{
boundaryId: String
farmerId: String
extensionId: String
extensionApiName: String
extensionApiInput: {
String: Object
}
extensionDataProviderAppId: String
extensionDataProviderApiKey: String
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
jobId
- ID of the job.public com.azure.core.experimental.http.DynamicRequest createDataIngestionJob(String jobId)
Request Body Schema
{
boundaryId: String
farmerId: String
extensionId: String
extensionApiName: String
extensionApiInput: {
String: Object
}
extensionDataProviderAppId: String
extensionDataProviderApiKey: String
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
Response Body Schema
(recursive schema, see above)
jobId
- Job id supplied by user.public com.azure.core.experimental.http.DynamicRequest getDataDeleteJobDetails(String jobId)
Response Body Schema
{
extensionId: String
farmerId: String
boundaryId: String
weatherDataType: String
granularity: String
startDateTime: OffsetDateTime
endDateTime: OffsetDateTime
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
jobId
- ID of the job.public com.azure.core.experimental.http.DynamicRequest createDataDeleteJob(String jobId)
Request Body Schema
{
extensionId: String
farmerId: String
boundaryId: String
weatherDataType: String
granularity: String
startDateTime: OffsetDateTime
endDateTime: OffsetDateTime
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
Response Body Schema
(recursive schema, see above)
jobId
- Job ID supplied by end user.public com.azure.core.experimental.http.DynamicRequest listNext(String nextLink)
Response Body Schema
{
value: [
{
farmerId: String
boundaryId: String
extensionId: String
location: {
latitude: double
longitude: double
}
dateTime: OffsetDateTime
unitSystemCode: String
extensionVersion: String
weatherDataType: String
granularity: String
cloudCover: {
unit: String
value: Double
}
dewPoint: (recursive schema, see dewPoint above)
growingDegreeDay: (recursive schema, see growingDegreeDay above)
precipitation: (recursive schema, see precipitation above)
pressure: (recursive schema, see pressure above)
relativeHumidity: (recursive schema, see relativeHumidity above)
soilMoisture: (recursive schema, see soilMoisture above)
soilTemperature: (recursive schema, see soilTemperature above)
temperature: (recursive schema, see temperature above)
visibility: (recursive schema, see visibility above)
wetBulbTemperature: (recursive schema, see wetBulbTemperature above)
windChill: (recursive schema, see windChill above)
windDirection: (recursive schema, see windDirection above)
windGust: (recursive schema, see windGust above)
windSpeed: (recursive schema, see windSpeed above)
id: String
eTag: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest invoke()
Copyright © 2021 Microsoft Corporation. All rights reserved.