Class WeatherAsyncClient

java.lang.Object
com.azure.verticals.agrifood.farming.WeatherAsyncClient

public final class WeatherAsyncClient extends Object
Initializes a new instance of the asynchronous FarmBeatsClient type.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginCreateDataDeleteJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
    Create a weather data delete job.
    com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginCreateDataIngestionJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
    Create a weather data ingestion job.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    getDataDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get weather data delete job.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    getDataIngestionJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get weather ingestion job.
    com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>
    list(String partyId, String boundaryId, String extensionId, String weatherDataType, String granularity, com.azure.core.http.rest.RequestOptions requestOptions)
    Returns a paginated list of weather data.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • list

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> list(String partyId, String boundaryId, String extensionId, String weatherDataType, String granularity, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns a paginated list of weather data.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      startDateTimeOffsetDateTimeNoWeather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
      endDateTimeOffsetDateTimeNoWeather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
      maxPageSizeIntegerNoMaximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
      skipTokenStringNoSkip token for getting next set of results.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

      
       {
           partyId: String (Required)
           boundaryId: String (Required)
           extensionId: String (Required)
           location (Required): {
               latitude: double (Required)
               longitude: double (Required)
           }
           dateTime: OffsetDateTime (Required)
           unitSystemCode: String (Optional)
           extensionVersion: String (Required)
           weatherDataType: String (Required)
           granularity: String (Required)
           cloudCover (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           dewPoint (Optional): (recursive schema, see dewPoint above)
           growingDegreeDay (Optional): (recursive schema, see growingDegreeDay above)
           precipitation (Optional): (recursive schema, see precipitation above)
           pressure (Optional): (recursive schema, see pressure above)
           relativeHumidity (Optional): (recursive schema, see relativeHumidity above)
           soilMoisture (Optional): (recursive schema, see soilMoisture above)
           soilTemperature (Optional): (recursive schema, see soilTemperature above)
           temperature (Optional): (recursive schema, see temperature above)
           visibility (Optional): (recursive schema, see visibility above)
           wetBulbTemperature (Optional): (recursive schema, see wetBulbTemperature above)
           windChill (Optional): (recursive schema, see windChill above)
           windDirection (Optional): (recursive schema, see windDirection above)
           windGust (Optional): (recursive schema, see windGust above)
           windSpeed (Optional): (recursive schema, see windSpeed above)
           id: String (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      partyId - Party ID.
      boundaryId - Boundary ID.
      extensionId - ID of the weather extension.
      weatherDataType - Type of weather data (forecast/historical).
      granularity - Granularity of weather data (daily/hourly).
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged response contains list of requested objects and a URL link to get the next set of results as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getDataDeleteJobDetailsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDataDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get weather data delete job.

      Response Body Schema

      
       {
           extensionId: String (Required)
           partyId: String (Required)
           boundaryId: String (Required)
           weatherDataType: String (Optional)
           granularity: String (Optional)
           startDateTime: OffsetDateTime (Optional)
           endDateTime: OffsetDateTime (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Id of the job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      weather data delete job along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • beginCreateDataDeleteJob

      public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateDataDeleteJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Create a weather data delete job.

      Request Body Schema

      
       {
           extensionId: String (Required)
           partyId: String (Required)
           boundaryId: String (Required)
           weatherDataType: String (Optional)
           granularity: String (Optional)
           startDateTime: OffsetDateTime (Optional)
           endDateTime: OffsetDateTime (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       

      Response Body Schema

      
       {
           extensionId: String (Required)
           partyId: String (Required)
           boundaryId: String (Required)
           weatherDataType: String (Optional)
           granularity: String (Optional)
           startDateTime: OffsetDateTime (Optional)
           endDateTime: OffsetDateTime (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Job Id supplied by end user.
      job - Job parameters supplied by user.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the PollerFlux for polling of schema of weather data delete job.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getDataIngestionJobDetailsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDataIngestionJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get weather ingestion job.

      Response Body Schema

      
       {
           boundaryId: String (Required)
           partyId: String (Required)
           extensionId: String (Required)
           extensionApiName: String (Required)
           extensionApiInput (Required): {
               String: Object (Required)
           }
           extensionDataProviderAppId: String (Optional)
           extensionDataProviderApiKey: String (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Id of the job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      weather ingestion job along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • beginCreateDataIngestionJob

      public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateDataIngestionJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Create a weather data ingestion job.

      Request Body Schema

      
       {
           boundaryId: String (Required)
           partyId: String (Required)
           extensionId: String (Required)
           extensionApiName: String (Required)
           extensionApiInput (Required): {
               String: Object (Required)
           }
           extensionDataProviderAppId: String (Optional)
           extensionDataProviderApiKey: String (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       

      Response Body Schema

      
       {
           boundaryId: String (Required)
           partyId: String (Required)
           extensionId: String (Required)
           extensionApiName: String (Required)
           extensionApiInput (Required): {
               String: Object (Required)
           }
           extensionDataProviderAppId: String (Optional)
           extensionDataProviderApiKey: String (Optional)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Job id supplied by user.
      job - Job parameters supplied by user.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the PollerFlux for polling of schema of weather ingestion job.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.