Package com.azure.verticals.agrifood.farming

Class SensorEventsClient

java.lang.Object

com.azure.verticals.agrifood.farming.SensorEventsClient

public final class SensorEventsClient
extends Object

Initializes a new instance of the synchronous FarmBeatsClient type.

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	listWithResponse(String sensorId, String sensorPartnerId, com.azure.core.http.rest.RequestOptions requestOptions)	Returns a list of sensor events data.

Methods inherited from class java.lang.Object

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

Method Details

listWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listWithResponse(String sensorId,
 String sensorPartnerId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Returns a list of sensor events data. Time span for query is limited to 90 days at a time. Returns last 90 days events when startDateTime and endDateTime are not provided.

Query Parameters

Query Parameters

Name	Type	Required	Description
startDateTime	OffsetDateTime	No	Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided.
endDateTime	OffsetDateTime	No	Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided.
excludeDuplicateEvents	Boolean	No	Flag to exclude duplicate events and take the latest ones only (Default: true).

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     value (Required): [
          (Required){
             sensorId: String (Optional)
             sensorPartnerId: String (Optional)
             partyId: String (Optional)
             boundaryId: String (Optional)
             eventDateTime: OffsetDateTime (Optional)
             ingestionDateTime: OffsetDateTime (Optional)
             measures (Optional): {
                 String: Object (Optional)
             }
         }
     ]
     skipToken: String (Optional)
     nextLink: String (Optional)
 }
 

Parameters:

sensorId - Id of the associated sensor.

sensorPartnerId - Id of the associated sensor partner.

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 along with Response.

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.