Package com.azure.verticals.agrifood.farming

Class WeatherBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.WeatherBaseClient

public final class WeatherBaseClient
extends Object

Initializes a new instance of the WeatherBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createDataDeleteJob(String jobId)	Create a weather data delete job.
DynamicRequest	createDataIngestionJob(String jobId)	Create a weather data ingestion job.
DynamicRequest	getDataDeleteJobDetails(String jobId)	Get weather data delete job.
DynamicRequest	getDataIngestionJobDetails(String jobId)	Get weather ingestion job.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list(String farmerId, String boundaryId, String extensionId, String weatherDataType, String granularity)	Returns a paginated list of weather data.
DynamicRequest	listNext(String nextLink)	Get the next page of items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

list

public DynamicRequest list(String farmerId,
 String boundaryId,
 String extensionId,
 String weatherDataType,
 String granularity)

Returns a paginated list of weather data.

Optional Query Parameters

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
 }
 

Parameters:

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).

Returns:

a DynamicRequest where customizations can be made before sent to the service.

getDataIngestionJobDetails

public DynamicRequest getDataIngestionJobDetails(String jobId)

Get weather ingestion job.

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
     }
 }
 

Parameters:

jobId - ID of the job.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

createDataIngestionJob

public DynamicRequest createDataIngestionJob(String jobId)

Create a weather data ingestion job.

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)
 

Parameters:

jobId - Job id supplied by user.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

getDataDeleteJobDetails

public DynamicRequest getDataDeleteJobDetails(String jobId)

Get weather data delete job.

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
     }
 }
 

Parameters:

jobId - ID of the job.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

createDataDeleteJob

public DynamicRequest createDataDeleteJob(String jobId)

Create a weather data delete job.

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)
 

Parameters:

jobId - Job ID supplied by end user.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

listNext

public DynamicRequest listNext(String nextLink)

Get the next page of items.

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
 }
 

Parameters:

nextLink - The nextLink parameter.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

invoke

public DynamicRequest invoke()

Create an empty DynamicRequest with the serializer and pipeline initialized for this client.

Returns:

a DynamicRequest where customizations can be made before sent to the service.