com.azure.verticals.agrifood.farming.InsightsAsyncClient

public final class InsightsAsyncClient 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>

beginCreateCascadeDeleteJob(String jobId, String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)

Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.

Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>

createOrUpdateWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.util.BinaryData insightData, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates insight entity.

Mono<com.azure.core.http.rest.Response<Void>>

deleteWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified insight resource.

Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>

getCascadeDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)

Get a cascade delete job for specified insight.

Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>

getWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)

Gets a specified insight resource under a particular party.

com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>

listByPartyIdModelIdAndResource(String partyId, String modelId, String resourceType, String resourceId, com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of insight resources.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

beginCreateCascadeDeleteJob

public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)
Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.
Response Body Schema
```
 {
     partyId: String (Required)
     resourceId: String (Required)
     resourceType: String (Required)
     id: String (Optional)
     status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
     durationInSeconds: Double (Optional)
     message: String (Optional)
     errorCode: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     lastActionDateTime: OffsetDateTime (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
 }
 
```
Parameters:

jobId - Job ID supplied by end user.

partyId - ID of the associated party.

modelId - Id of the associated model.

resourceType - Resource Type.

resourceId - Id of the associated resource.

insightId - Insight id.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the PollerFlux for polling of schema of cascade 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.
getCascadeDeleteJobDetailsWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCascadeDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
Get a cascade delete job for specified insight.
Response Body Schema
```
 {
     partyId: String (Required)
     resourceId: String (Required)
     resourceType: String (Required)
     id: String (Optional)
     status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional)
     durationInSeconds: Double (Optional)
     message: String (Optional)
     errorCode: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     lastActionDateTime: OffsetDateTime (Optional)
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
 }
 
```
Parameters:

jobId - Id of the job.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a cascade delete job for specified insight 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.

listByPartyIdModelIdAndResource

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listByPartyIdModelIdAndResource(String partyId, String modelId, String resourceType, String resourceId, com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of insight resources.

Query Parameters

Query Parameters
Name	Type	Required	Description
minInsightStartDateTime	OffsetDateTime	No	Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
maxInsightStartDateTime	OffsetDateTime	No	Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
minInsightEndDateTime	OffsetDateTime	No	Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
maxInsightEndDateTime	OffsetDateTime	No	Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
measurementFilters	List<String>	No	Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. eg. "measureKey.unit eq {testValue}" where testValue is string. eg. "measureKey.value eq {testValue}" where testValue = double. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
ids	List<String>	No	Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
names	List<String>	No	Names of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
propertyFilters	List<String>	No	Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
statuses	List<String>	No	Statuses of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
minCreatedDateTime	OffsetDateTime	No	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	No	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	No	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	No	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	No	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	No	Skip 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 (Optional)
     modelId: String (Optional)
     resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
     resourceId: String (Optional)
     modelVersion: String (Optional)
     attachmentsLink: String (Optional)
     insightStartDateTime: OffsetDateTime (Optional)
     insightEndDateTime: OffsetDateTime (Optional)
     measurements (Optional): {
         String (Optional): {
             unit: String (Optional)
             value: Double (Optional)
         }
     }
     id: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     eTag: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: partyId - Id of the associated party.; modelId - Id of the associated model.; resourceType - Resource type associated with the record.; resourceId - Id of the associated resource.; 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.

createOrUpdateWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.util.BinaryData insightData, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates insight entity.

Request Body Schema


 {
     partyId: String (Optional)
     modelId: String (Optional)
     resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
     resourceId: String (Optional)
     modelVersion: String (Optional)
     attachmentsLink: String (Optional)
     insightStartDateTime: OffsetDateTime (Optional)
     insightEndDateTime: OffsetDateTime (Optional)
     measurements (Optional): {
         String (Optional): {
             unit: String (Optional)
             value: Double (Optional)
         }
     }
     id: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     eTag: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Response Body Schema


 {
     partyId: String (Optional)
     modelId: String (Optional)
     resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
     resourceId: String (Optional)
     modelVersion: String (Optional)
     attachmentsLink: String (Optional)
     insightStartDateTime: OffsetDateTime (Optional)
     insightEndDateTime: OffsetDateTime (Optional)
     measurements (Optional): {
         String (Optional): {
             unit: String (Optional)
             value: Double (Optional)
         }
     }
     id: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     eTag: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: partyId - Id of the associated party.; modelId - Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.; resourceType - Resource type associated with the record.; resourceId - Id of the associated resource.; insightId - Id of the insight resource.; insightData - Insight data.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: schema of insight resource 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.

getWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)
Gets a specified insight resource under a particular party.
Response Body Schema
```
 {
     partyId: String (Optional)
     modelId: String (Optional)
     resourceType: String(Party/Farm/Field/SeasonalField/Boundary) (Optional)
     resourceId: String (Optional)
     modelVersion: String (Optional)
     attachmentsLink: String (Optional)
     insightStartDateTime: OffsetDateTime (Optional)
     insightEndDateTime: OffsetDateTime (Optional)
     measurements (Optional): {
         String (Optional): {
             unit: String (Optional)
             value: Double (Optional)
         }
     }
     id: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     eTag: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }
 
```
Parameters:

partyId - Id of the associated party.

modelId - Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.

resourceType - Resource type associated with the record.

resourceId - Id of the associated resource.

insightId - Id of the insight resource.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a specified insight resource under a particular party 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.
deleteWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponse(String partyId, String modelId, String resourceType, String resourceId, String insightId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified insight resource.

Parameters:

partyId - Id of the associated party.

modelId - Id of the associated model. It can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.

resourceType - Resource type associated with the record.

resourceId - Id of the associated resource.

insightId - Id of the insight resource.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

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

Class InsightsAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

beginCreateCascadeDeleteJob

getCascadeDeleteJobDetailsWithResponse

listByPartyIdModelIdAndResource

createOrUpdateWithResponse

getWithResponse

deleteWithResponse