FarmClient.CreateDataIngestionJob(String, RequestContent, RequestOptions) Method

Definition

Create a farm operation data ingestion job.

public virtual Azure.Response CreateDataIngestionJob (string jobId, Azure.Core.RequestContent requestBody, Azure.RequestOptions requestOptions = default);
abstract member CreateDataIngestionJob : string * Azure.Core.RequestContent * Azure.RequestOptions -> Azure.Response
override this.CreateDataIngestionJob : string * Azure.Core.RequestContent * Azure.RequestOptions -> Azure.Response
Public Overridable Function CreateDataIngestionJob (jobId As String, requestBody As RequestContent, Optional requestOptions As RequestOptions = Nothing) As Response

Parameters

jobId
System.String

Job ID supplied by user.

requestBody
RequestContent

The request body.

requestOptions
RequestOptions

The request options.

Returns

Response

Remarks

Schema for Request Body:

farmerIdstringYes Farmer ID.
authProviderIdstringYes Authentication provider ID.
operationsstring[] List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.
startYearnumberYes Start Year (Minimum = 2000, Maximum = CurrentYear).
idstring Unique job id.
statusstring Status of the job.

Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

durationInSecondsnumber Duration of the job in seconds.
messagestring Status message to capture more details of the job.
createdDateTimestring (ISO 8601 Format) Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
lastActionDateTimestring (ISO 8601 Format) Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
startTimestring (ISO 8601 Format) Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
endTimestring (ISO 8601 Format) Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
namestring Name to identify resource.
descriptionstring Textual description of the resource.
propertiesDictionary<string, AnyObject> 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 and numeral values are supported.

Applies to