FarmOperationsDataIngestion.GetJobDetailsAsync(String, RequestContext) メソッド

定義

名前空間:

Azure.Verticals.AgriFood.Farming

アセンブリ:

Azure.Verticals.AgriFood.Farming.dll

パッケージ:

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

ソース:

FarmOperationsDataIngestion.cs

ファーム操作データ インジェスト ジョブを取得します。

public virtual System.Threading.Tasks.Task<Azure.Response> GetJobDetailsAsync (string jobId, Azure.RequestContext context = default);

abstract member GetJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetJobDetailsAsync (jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

パラメーター

jobId

String

ジョブの ID。

context

RequestContext

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

戻り値

Task<Response>

サービスから返された応答。 応答本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

jobId が null です。

ArgumentException

jobId は空の文字列であり、空でないと予想されていました。

RequestFailedException

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

例

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

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

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

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("authProviderId").ToString());
Console.WriteLine(result.GetProperty("operations")[0].ToString());
Console.WriteLine(result.GetProperty("startYear").ToString());
Console.WriteLine(result.GetProperty("isIncremental").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());

注釈

応答ペイロードの JSON スキーマを次に示します。

応答本文:

の FarmOperationDataIngestionJobスキーマ:

{
  partyId: string, # Required. Party Id.
  authProviderId: string, # Required. Authentication provider Id.
  operations: [string], # Optional. List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.
  startYear: number, # Required. Start Year (Minimum = 2000, Maximum = CurrentYear).
  isIncremental: boolean, # Optional. Use this to pull only the incremental changes from the last run.
  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.
}