ModelInference.GetSoilMoistureModelJob(String, RequestContext) Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

Source:

ModelInference.cs

Get SoilMoisture Model job's details.

public virtual Azure.Response GetSoilMoistureModelJob (string jobId, Azure.RequestContext context = default);

abstract member GetSoilMoistureModelJob : string * Azure.RequestContext -> Azure.Response
override this.GetSoilMoistureModelJob : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetSoilMoistureModelJob (jobId As String, Optional context As RequestContext = Nothing) As Response

Parameters

jobId

String

Id of the job.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

jobId is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetSoilMoistureModelJob with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetModelInferenceClient(<2022-11-01-preview>);

Response response = client.GetSoilMoistureModelJob("<jobId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("boundaryId").ToString());
Console.WriteLine(result.GetProperty("sensorDataModelId").ToString());
Console.WriteLine(result.GetProperty("sensorPartnerId").ToString());
Console.WriteLine(result.GetProperty("inferenceStartDateTime").ToString());
Console.WriteLine(result.GetProperty("inferenceEndDateTime").ToString());
Console.WriteLine(result.GetProperty("satelliteProvider").ToString());
Console.WriteLine(result.GetProperty("satelliteSource").ToString());
Console.WriteLine(result.GetProperty("imageResolution").ToString());
Console.WriteLine(result.GetProperty("imageFormat").ToString());
Console.WriteLine(result.GetProperty("modelVersion").ToString());
Console.WriteLine(result.GetProperty("sensorDefinition").GetProperty("sensorMeasurement").ToString());
Console.WriteLine(result.GetProperty("sensorDefinition").GetProperty("minProperty").ToString());
Console.WriteLine(result.GetProperty("sensorDefinition").GetProperty("maxProperty").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("durationInSeconds").ToString());
Console.WriteLine(result.GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errorCode").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
Console.WriteLine(result.GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("modifiedBy").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for SoilMoistureModelJob:

{
  partyId: string, # Required. Party Id.
  boundaryId: string, # Required. The id of the boundary object for which soil moisture is being calculated.
  sensorDataModelId: string, # Required. Sensor data model Id.
  sensorPartnerId: string, # Required. Sensor partner Id.
  inferenceStartDateTime: string (ISO 8601 Format), # Required. Inference start date time for soil moisture calculations.
  inferenceEndDateTime: string (ISO 8601 Format), # Required. Inference end date time for soil moisture calculations.
  satelliteProvider: "Microsoft", # Required. Provider of satellite data. Available Value: Microsoft.
  satelliteSource: "Sentinel_2_L2A" | "Sentinel_2_L1C", # Required. Source of satellite data. Available Value: Sentinel_2_L2A.
  imageResolution: number, # Required. ImageResolution in meters. Available values: 10, 20, 60.
  imageFormat: "TIF", # Required. ImageFormat. Available value: TIF.
  modelVersion: string, # Required. The version of the soil moisture model to be run.
  sensorDefinition: {
    sensorMeasurement: string, # Required. The measurement name for sensor measure in sensorDataModel.
    minProperty: string, # Required. The measurement name for minimum measurement value.
    maxProperty: string, # Required. The measurement name for maximum measurement value.
  }, # Required. Schema for storing sensor definition keywords.
  id: string, # Optional. Unique job id.
  status: string, # Optional. Status of the job.
Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  durationInSeconds: number, # Optional. Duration of the job in seconds.
  message: string, # Optional. Status message to capture more details of the job.
  errorCode: string, # Optional. Error Code when job failed.
  createdDateTime: string (ISO 8601 Format), # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  lastActionDateTime: string (ISO 8601 Format), # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  startTime: string (ISO 8601 Format), # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  endTime: string (ISO 8601 Format), # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}