com.azure.verticals.agrifood.farming.ModelInferenceClient

public final class ModelInferenceClient extends Object

Initializes a new instance of the synchronous FarmBeatsClient type.

Method Summary

Modifier and Type

Method

Description

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginCreateBiomassModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a Biomass Model job.

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginCreateSensorPlacementModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a Sensor Placement Model job.

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginCreateSoilMoistureModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a SoilMoisture Model job.

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

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

Get Biomass Model job's details.

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

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

Get Sensor Placement Model job's details.

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

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

Get SoilMoisture Model job's details.

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

Method Details

beginCreateBiomassModelJob

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateBiomassModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a Biomass Model job.

Request Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     cropName: String(Corn) (Required)
     plantingStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     weatherExtensionId: String (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     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


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     cropName: String(Corn) (Required)
     plantingStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     weatherExtensionId: String (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     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 - JobId provided by user.; job - Job parameters supplied by user.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the SyncPoller for polling of schema of biomass model 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.

getBiomassModelJobWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getBiomassModelJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)

Get Biomass Model job's details.

Response Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     cropName: String(Corn) (Required)
     plantingStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     weatherExtensionId: String (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     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:: biomass Model job's details 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.

beginCreateSensorPlacementModelJob

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateSensorPlacementModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a Sensor Placement Model job.

Request Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     sensorType: String (Required)
     isRanked: boolean (Required)
     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


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     sensorType: String (Required)
     isRanked: boolean (Required)
     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 - JobId provided by user.; job - Job parameters supplied by user.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the SyncPoller for polling of schema of sensor placement model 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.

getSensorPlacementModelJobWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getSensorPlacementModelJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)

Get Sensor Placement Model job's details.

Response Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     modelVersion: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     sensorType: String (Required)
     isRanked: boolean (Required)
     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:: sensor Placement Model job's details 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.

beginCreateSoilMoistureModelJob

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateSoilMoistureModelJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)

Create a SoilMoisture Model job.

Request Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     sensorDataModelId: String (Required)
     sensorPartnerId: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     modelVersion: String (Required)
     sensorDefinition (Required): {
         sensorMeasurement: String (Required)
         minProperty: String (Required)
         maxProperty: String (Required)
     }
     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


 {
     partyId: String (Required)
     boundaryId: String (Required)
     sensorDataModelId: String (Required)
     sensorPartnerId: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     modelVersion: String (Required)
     sensorDefinition (Required): {
         sensorMeasurement: String (Required)
         minProperty: String (Required)
         maxProperty: String (Required)
     }
     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 - JobId provided by user.; job - Job parameters supplied by user.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the SyncPoller for polling of schema of soil moisture model 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.

getSoilMoistureModelJobWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getSoilMoistureModelJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)

Get SoilMoisture Model job's details.

Response Body Schema


 {
     partyId: String (Required)
     boundaryId: String (Required)
     sensorDataModelId: String (Required)
     sensorPartnerId: String (Required)
     inferenceStartDateTime: OffsetDateTime (Required)
     inferenceEndDateTime: OffsetDateTime (Required)
     satelliteProvider: String(Microsoft) (Required)
     satelliteSource: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
     imageResolution: double (Required)
     imageFormat: String(TIF) (Required)
     modelVersion: String (Required)
     sensorDefinition (Required): {
         sensorMeasurement: String (Required)
         minProperty: String (Required)
         maxProperty: String (Required)
     }
     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:: soilMoisture Model job's details 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.

Class ModelInferenceClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

beginCreateBiomassModelJob

getBiomassModelJobWithResponse

beginCreateSensorPlacementModelJob

getSensorPlacementModelJobWithResponse

beginCreateSoilMoistureModelJob

getSoilMoistureModelJobWithResponse