Scenes.GetScenesAsync メソッド

リファレンス

定義

名前空間:: Azure.Verticals.AgriFood.Farming

アセンブリ:: Azure.Verticals.AgriFood.Farming.dll

パッケージ:: Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

ソース:: Scenes.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

シーンリソースのページ分割されたリストを返します。

public virtual Azure.AsyncPageable<BinaryData> GetScenesAsync (string provider, string partyId, string boundaryId, string source, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, double? maxCloudCoveragePercentage = default, double? maxDarkPixelCoveragePercentage = default, System.Collections.Generic.IEnumerable<string> imageNames = default, System.Collections.Generic.IEnumerable<double> imageResolutions = default, System.Collections.Generic.IEnumerable<string> imageFormats = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);

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

Public Overridable Function GetScenesAsync (provider As String, partyId As String, boundaryId As String, source As String, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxCloudCoveragePercentage As Nullable(Of Double) = Nothing, Optional maxDarkPixelCoveragePercentage As Nullable(Of Double) = Nothing, Optional imageNames As IEnumerable(Of String) = Nothing, Optional imageResolutions As IEnumerable(Of Double) = Nothing, Optional imageFormats As IEnumerable(Of String) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

パラメーター

provider: String

シーンデータのプロバイダー名。

partyId: String

PartyId。

boundaryId: String

BoundaryId。

source: String

シーンデータのソース名、使用可能な値: Sentinel_2_L2A、Sentinel_2_L1C。

startDateTime: Nullable<DateTimeOffset>

シーン開始 UTC datetime (包括)、サンプル形式: yyyy-MM-ddThh:mm:ssZ。

endDateTime: Nullable<DateTimeOffset>

シーン終了 UTC datetime (包括)、サンプル形式: yyyy-MM-dThh:mm:ssZ。

maxCloudCoveragePercentage: Nullable<Double>

クラウドカバレッジ率が最大値未満のシーンをフィルター処理します。範囲 [0 から 100.0]。

maxDarkPixelCoveragePercentage: Nullable<Double>

暗いピクセルカバレッジ率が最大値より小さいシーンをフィルター処理します。範囲 [0 から 100.0]。

imageNames: IEnumerable<String>

フィルター処理するイメージ名の一覧。

imageResolutions: IEnumerable<Double>

フィルター処理する画像解像度の一覧 (メートル単位)。

imageFormats: IEnumerable<String>

フィルター処理する画像形式の一覧。

maxPageSize: Nullable<Int32>

必要な項目の最大数 (含む)。 Minimum = 10、Maximum = 1000、既定値 = 50。

skipToken: String

次の結果セットを取得するためのトークンをスキップします。

context: RequestContext

要求コンテキスト。これは、呼び出しごとにクライアントパイプラインの既定の動作をオーバーライドできます。

戻り値

AsyncPageable<BinaryData>

AsyncPageable<T>オブジェクトの一覧を含むサービスの BinaryData 。コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

provider、partyId、boundaryId、または source が null です。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して GetScenesAsync を呼び出し、結果を解析する方法を示します。

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

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

このサンプルでは、すべてのパラメーターを使用して GetScenesAsync を呼び出す方法と、結果を解析する方法を示します。

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

await foreach (var data in client.GetScenesAsync("<provider>", "<partyId>", "<boundaryId>", "<source>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, 1234, new String[]{"<imageNames>"}, new Double[]{1234}, new String[]{"<imageFormats>"}, 1234, "<skipToken>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("sceneDateTime").ToString());
    Console.WriteLine(result.GetProperty("provider").ToString());
    Console.WriteLine(result.GetProperty("source").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("fileLink").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("imageFormat").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("resolution").ToString());
    Console.WriteLine(result.GetProperty("imageFormat").ToString());
    Console.WriteLine(result.GetProperty("cloudCoverPercentage").ToString());
    Console.WriteLine(result.GetProperty("darkPixelPercentage").ToString());
    Console.WriteLine(result.GetProperty("ndviMedianValue").ToString());
    Console.WriteLine(result.GetProperty("boundaryId").ToString());
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
}

注釈

ページング可能な応答の 1 つの項目の JSON スキーマを次に示します。

応答本文:

の SceneListResponseValueスキーマ:

{
  sceneDateTime: string (ISO 8601 Format), # Optional. Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.
  provider: string, # Optional. Data provider of the scene.
  source: string, # Optional. Data source of the scene.
  imageFiles: [
    {
      fileLink: string, # Optional. Link of the image file.
      name: string, # Required. Name of the image file.
      imageFormat: "TIF", # Optional. ImageFormat. Available value: TIF.
      resolution: number, # Optional. Resolution of image file in meters.
    }
  ], # Optional. Collection of image files.
  imageFormat: "TIF", # Optional. ImageFormat. Available value: TIF.
  cloudCoverPercentage: number, # Optional. Cloud cover percentage of the scene.
  darkPixelPercentage: number, # Optional. Dark pixel percentage of the scene.
  ndviMedianValue: number, # Optional. Median of NDVI of the scene.
  boundaryId: string, # Optional. Boundary ID which belongs to the scene.
  partyId: string, # Optional. Party ID which belongs to the scene.
  id: string, # Optional. Unique scene resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
}

適用対象

次の方法で共有

Scenes.GetScenesAsync メソッド

定義

パラメーター

戻り値

例外

例

注釈

適用対象

その他のリソース