NutrientAnalyses.GetNutrientAnalysesAsync Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

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

Source:

NutrientAnalyses.cs

Returns a paginated list of nutrient analysis resources across all parties.

public virtual Azure.AsyncPageable<BinaryData> GetNutrientAnalysesAsync (string parentType = default, System.Collections.Generic.IEnumerable<string> parentIds = default, System.Collections.Generic.IEnumerable<string> classifications = 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 GetNutrientAnalysesAsync : string * seq<string> * seq<string> * 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.GetNutrientAnalysesAsync : string * seq<string> * seq<string> * 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 GetNutrientAnalysesAsync (Optional parentType As String = Nothing, Optional parentIds As IEnumerable(Of String) = Nothing, Optional classifications As IEnumerable(Of String) = 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

parentType

String

Type of the parent it belongs to. i.e. PlantTissueAnalysis.

parentIds

IEnumerable<String>

Parent ids of the resource.

classifications

IEnumerable<String>

Classifications for nutrient analyses.

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetNutrientAnalysesAsync and parse the result.

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

await foreach (var data in client.GetNutrientAnalysesAsync())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

await foreach (var data in client.GetNutrientAnalysesAsync("<parentType>", new String[]{"<parentIds>"}, new String[]{"<classifications>"}, 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("partyId").ToString());
    Console.WriteLine(result.GetProperty("parentId").ToString());
    Console.WriteLine(result.GetProperty("parentType").ToString());
    Console.WriteLine(result.GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("referenceValueLow").ToString());
    Console.WriteLine(result.GetProperty("referenceValueHigh").ToString());
    Console.WriteLine(result.GetProperty("classification").ToString());
    Console.WriteLine(result.GetProperty("recommendation").ToString());
    Console.WriteLine(result.GetProperty("products")[0].GetProperty("rate").ToString());
    Console.WriteLine(result.GetProperty("products")[0].GetProperty("instruction").ToString());
    Console.WriteLine(result.GetProperty("products")[0].GetProperty("product").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 NutrientAnalysisListResponseValue:

{
  partyId: string, # Optional. Party id for this nutrient analysis.
  parentId: string, # Optional. Parent id for this nutrient analysis.
  parentType: "PlantTissueAnalysis", # Optional. Parent type for this nutrient analysis.
i.e. PlantTissueAnalysis.
  unit: string, # Optional. Unit for this nutrient analysis.
  value: number, # Optional. Value for this nutrient analysis.
  referenceValueLow: number, # Optional. Reference value low for this nutrient analysis.
  referenceValueHigh: number, # Optional. Reference value high for this nutrient analysis.
  classification: string, # Optional. Classification for this nutrient analysis.
  recommendation: string, # Optional. Recommendation for this nutrient analysis.
  products: [
    {
      rate: string, # Optional. Rate of the product.
      instruction: string, # Optional. Instruction of the resource.
      product: string, # Optional. Product of the resource.
    }
  ], # Optional. Products for this nutrient analysis.
  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.
}