HarvestData.GetAllHarvestDataByPartyIdAsync Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

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

Source:: HarvestData.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a paginated list of harvest data resources under a particular farm.

public virtual Azure.AsyncPageable<BinaryData> GetAllHarvestDataByPartyIdAsync (string partyId, double? minTotalYield = default, double? maxTotalYield = default, double? minAvgYield = default, double? maxAvgYield = default, double? minTotalWetMass = default, double? maxTotalWetMass = default, double? minAvgWetMass = default, double? maxAvgWetMass = default, double? minAvgMoisture = default, double? maxAvgMoisture = default, double? minAvgSpeed = default, double? maxAvgSpeed = default, System.Collections.Generic.IEnumerable<string> sources = default, System.Collections.Generic.IEnumerable<string> associatedBoundaryIds = default, DateTimeOffset? minOperationStartDateTime = default, DateTimeOffset? maxOperationStartDateTime = default, DateTimeOffset? minOperationEndDateTime = default, DateTimeOffset? maxOperationEndDateTime = default, DateTimeOffset? minOperationModifiedDateTime = default, DateTimeOffset? maxOperationModifiedDateTime = default, double? minArea = default, double? maxArea = default, System.Collections.Generic.IEnumerable<string> ids = default, System.Collections.Generic.IEnumerable<string> names = default, System.Collections.Generic.IEnumerable<string> propertyFilters = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? minCreatedDateTime = default, DateTimeOffset? maxCreatedDateTime = default, DateTimeOffset? minLastModifiedDateTime = default, DateTimeOffset? maxLastModifiedDateTime = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);

abstract member GetAllHarvestDataByPartyIdAsync : string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<double> * Nullable<double> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllHarvestDataByPartyIdAsync : string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<double> * Nullable<double> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetAllHarvestDataByPartyIdAsync (partyId As String, Optional minTotalYield As Nullable(Of Double) = Nothing, Optional maxTotalYield As Nullable(Of Double) = Nothing, Optional minAvgYield As Nullable(Of Double) = Nothing, Optional maxAvgYield As Nullable(Of Double) = Nothing, Optional minTotalWetMass As Nullable(Of Double) = Nothing, Optional maxTotalWetMass As Nullable(Of Double) = Nothing, Optional minAvgWetMass As Nullable(Of Double) = Nothing, Optional maxAvgWetMass As Nullable(Of Double) = Nothing, Optional minAvgMoisture As Nullable(Of Double) = Nothing, Optional maxAvgMoisture As Nullable(Of Double) = Nothing, Optional minAvgSpeed As Nullable(Of Double) = Nothing, Optional maxAvgSpeed As Nullable(Of Double) = Nothing, Optional sources As IEnumerable(Of String) = Nothing, Optional associatedBoundaryIds As IEnumerable(Of String) = Nothing, Optional minOperationStartDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxOperationStartDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minOperationEndDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxOperationEndDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minOperationModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxOperationModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minArea As Nullable(Of Double) = Nothing, Optional maxArea As Nullable(Of Double) = Nothing, Optional ids As IEnumerable(Of String) = Nothing, Optional names As IEnumerable(Of String) = Nothing, Optional propertyFilters As IEnumerable(Of String) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional minCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

partyId: String

ID of the associated party.

minTotalYield: Nullable<Double>

Minimum Yield value(inclusive).

maxTotalYield: Nullable<Double>

Maximum Yield value (inclusive).

minAvgYield: Nullable<Double>

Minimum AvgYield value(inclusive).

maxAvgYield: Nullable<Double>

Maximum AvgYield value (inclusive).

minTotalWetMass: Nullable<Double>

Minimum Total WetMass value(inclusive).

maxTotalWetMass: Nullable<Double>

Maximum Total WetMass value (inclusive).

minAvgWetMass: Nullable<Double>

Minimum AvgWetMass value(inclusive).

maxAvgWetMass: Nullable<Double>

Maximum AvgWetMass value (inclusive).

minAvgMoisture: Nullable<Double>

Minimum AvgMoisture value(inclusive).

maxAvgMoisture: Nullable<Double>

Maximum AvgMoisture value (inclusive).

minAvgSpeed: Nullable<Double>

Minimum AvgSpeed value(inclusive).

maxAvgSpeed: Nullable<Double>

Maximum AvgSpeed value (inclusive).

sources: IEnumerable<String>

Sources of the operation data.

associatedBoundaryIds: IEnumerable<String>

Boundary IDs associated with operation data.

minOperationStartDateTime: Nullable<DateTimeOffset>

Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxOperationStartDateTime: Nullable<DateTimeOffset>

Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minOperationEndDateTime: Nullable<DateTimeOffset>

Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxOperationEndDateTime: Nullable<DateTimeOffset>

Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minOperationModifiedDateTime: Nullable<DateTimeOffset>

Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxOperationModifiedDateTime: Nullable<DateTimeOffset>

Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minArea: Nullable<Double>

Minimum area for which operation was applied (inclusive).

maxArea: Nullable<Double>

Maximum area for which operation was applied (inclusive).

ids: IEnumerable<String>

Ids of the resource.

names: IEnumerable<String>

Names of the resource.

propertyFilters: IEnumerable<String>

Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".

statuses: IEnumerable<String>

Statuses of the resource.

minCreatedDateTime: Nullable<DateTimeOffset>

Minimum creation date of resource (inclusive).

maxCreatedDateTime: Nullable<DateTimeOffset>

Maximum creation date of resource (inclusive).

minLastModifiedDateTime: Nullable<DateTimeOffset>

Minimum last modified date of resource (inclusive).

maxLastModifiedDateTime: Nullable<DateTimeOffset>

Maximum last modified date of resource (inclusive).

maxPageSize: Nullable<Int32>

Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.

skipToken: String

Skip token for getting next set of results.

context: RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

partyId is null.

ArgumentException

partyId 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 GetAllHarvestDataByPartyIdAsync with required parameters and parse the result.

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

await foreach (var data in client.GetAllHarvestDataByPartyIdAsync("<partyId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetAllHarvestDataByPartyIdAsync with all parameters, and how to parse the result.

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

await foreach (var data in client.GetAllHarvestDataByPartyIdAsync("<partyId>", 1234, 1234, 1234, 1234, 1234, 1234, 1234, 1234, 1234, 1234, 1234, 1234, new String[]{"<sources>"}, new String[]{"<associatedBoundaryIds>"}, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, 1234, new String[]{"<ids>"}, new String[]{"<names>"}, new String[]{"<propertyFilters>"}, new String[]{"<statuses>"}, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, "<skipToken>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("totalYield").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("totalYield").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("avgYield").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("avgYield").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("totalWetMass").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("totalWetMass").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("avgWetMass").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("avgWetMass").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("avgMoisture").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("avgMoisture").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("avgSpeed").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("avgSpeed").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("productName").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("area").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("area").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("totalYield").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("totalYield").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgYield").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgYield").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgMoisture").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgMoisture").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("totalWetMass").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("totalWetMass").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgWetMass").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("harvestProductDetails")[0].GetProperty("avgWetMass").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("operationModifiedDateTime").ToString());
    Console.WriteLine(result.GetProperty("operationStartDateTime").ToString());
    Console.WriteLine(result.GetProperty("operationEndDateTime").ToString());
    Console.WriteLine(result.GetProperty("attachmentsLink").ToString());
    Console.WriteLine(result.GetProperty("associatedBoundaryId").ToString());
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
    Console.WriteLine(result.GetProperty("status").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
    Console.WriteLine(result.GetProperty("source").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 one item in the pageable response.

Response Body:

Schema for HarvestDataListResponseValue:

{
  totalYield: {
    unit: string, # Optional. Data unit.
    value: number, # Optional. Data value.
  }, # Optional. Schema for storing measurement reading and unit.
  avgYield: Measure, # Optional. Schema for storing measurement reading and unit.
  totalWetMass: Measure, # Optional. Schema for storing measurement reading and unit.
  avgWetMass: Measure, # Optional. Schema for storing measurement reading and unit.
  avgMoisture: Measure, # Optional. Schema for storing measurement reading and unit.
  avgSpeed: Measure, # Optional. Schema for storing measurement reading and unit.
  harvestProductDetails: [
    {
      productName: string, # Optional. Name of the product.
      area: Measure, # Optional. Schema for storing measurement reading and unit.
      totalYield: Measure, # Optional. Schema for storing measurement reading and unit.
      avgYield: Measure, # Optional. Schema for storing measurement reading and unit.
      avgMoisture: Measure, # Optional. Schema for storing measurement reading and unit.
      totalWetMass: Measure, # Optional. Schema for storing measurement reading and unit.
      avgWetMass: Measure, # Optional. Schema for storing measurement reading and unit.
    }
  ], # Optional. Harvest product details.
  area: Measure, # Optional. Schema for storing measurement reading and unit.
  operationModifiedDateTime: string (ISO 8601 Format), # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
Note: this will be specified by the source provider itself.
  operationStartDateTime: string (ISO 8601 Format), # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
  operationEndDateTime: string (ISO 8601 Format), # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
  attachmentsLink: string, # Optional. Link for attachments.
  associatedBoundaryId: string, # Optional. Optional boundary ID of the field for which operation was applied.
  partyId: string, # Optional. Party ID which belongs to the operation data.
  id: string, # Optional. Unique resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  status: string, # Optional. Status of the resource.
  createdDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
  modifiedDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
  source: string, # Optional. Source of the resource.
  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.
}

Applies to

Delen via