xml/Azure.Verticals.AgriFood.Farming/Weather.xml

<Type Name="Weather" FullName="Azure.Verticals.AgriFood.Farming.Weather"> <TypeSignature Language="C#" Value="public class Weather" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Weather extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.Verticals.AgriFood.Farming.Weather" /> <TypeSignature Language="VB.NET" Value="Public Class Weather" /> <TypeSignature Language="F#" Value="type Weather = class" /> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The Weather sub-client. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Weather ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of Weather for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CreateDataDeleteJob"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CreateDataDeleteJob (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CreateDataDeleteJob(valuetype Azure.WaitUntil waitUntil, string jobId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.CreateDataDeleteJob(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateDataDeleteJob (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member CreateDataDeleteJob : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CreateDataDeleteJob : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="weather.CreateDataDeleteJob (waitUntil, jobId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Operation<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="jobId"> Job Id supplied by end user. </param> <param name="content"> The content to send as the body of the request. Details of the request body schema are in the Remarks section below. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Create a weather data delete job. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the request and response payloads. Request Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code> Response Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateDataDeleteJob with required parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { extensionId = "<extensionId>", partyId = "<partyId>", boundaryId = "<boundaryId>", }; var operation = client.CreateDataDeleteJob(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); ]]></code> This sample shows how to call CreateDataDeleteJob with all parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { extensionId = "<extensionId>", partyId = "<partyId>", boundaryId = "<boundaryId>", weatherDataType = "<weatherDataType>", granularity = "<granularity>", startDateTime = "2022-05-10T18:57:31.2311892Z", endDateTime = "2022-05-10T18:57:31.2311892Z", name = "<name>", description = "<description>", properties = new { key = new {}, }, }; var operation = client.CreateDataDeleteJob(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("endDateTime").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()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateDataDeleteJobAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CreateDataDeleteJobAsync (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class System.BinaryData>> CreateDataDeleteJobAsync(valuetype Azure.WaitUntil waitUntil, string jobId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.CreateDataDeleteJobAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateDataDeleteJobAsync (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member CreateDataDeleteJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CreateDataDeleteJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="weather.CreateDataDeleteJobAsync (waitUntil, jobId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="jobId"> Job Id supplied by end user. </param> <param name="content"> The content to send as the body of the request. Details of the request body schema are in the Remarks section below. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Create a weather data delete job. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the request and response payloads. Request Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code> Response Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateDataDeleteJobAsync with required parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { extensionId = "<extensionId>", partyId = "<partyId>", boundaryId = "<boundaryId>", }; var operation = await client.CreateDataDeleteJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); ]]></code> This sample shows how to call CreateDataDeleteJobAsync with all parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { extensionId = "<extensionId>", partyId = "<partyId>", boundaryId = "<boundaryId>", weatherDataType = "<weatherDataType>", granularity = "<granularity>", startDateTime = "2022-05-10T18:57:31.2311892Z", endDateTime = "2022-05-10T18:57:31.2311892Z", name = "<name>", description = "<description>", properties = new { key = new {}, }, }; var operation = await client.CreateDataDeleteJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("endDateTime").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()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateDataIngestionJob"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CreateDataIngestionJob (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CreateDataIngestionJob(valuetype Azure.WaitUntil waitUntil, string jobId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.CreateDataIngestionJob(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateDataIngestionJob (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member CreateDataIngestionJob : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CreateDataIngestionJob : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="weather.CreateDataIngestionJob (waitUntil, jobId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Operation<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="jobId"> Job id supplied by user. </param> <param name="content"> The content to send as the body of the request. Details of the request body schema are in the Remarks section below. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Create a weather data ingestion job. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the request and response payloads. Request Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code> Response Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateDataIngestionJob with required parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { boundaryId = "<boundaryId>", partyId = "<partyId>", extensionId = "<extensionId>", extensionApiName = "<extensionApiName>", extensionApiInput = new { key = new {}, }, }; var operation = client.CreateDataIngestionJob(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); ]]></code> This sample shows how to call CreateDataIngestionJob with all parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { boundaryId = "<boundaryId>", partyId = "<partyId>", extensionId = "<extensionId>", extensionApiName = "<extensionApiName>", extensionApiInput = new { key = new {}, }, extensionDataProviderAppId = "<extensionDataProviderAppId>", extensionDataProviderApiKey = "<extensionDataProviderApiKey>", name = "<name>", description = "<description>", properties = new { key = new {}, }, }; var operation = client.CreateDataIngestionJob(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderAppId").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderApiKey").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()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateDataIngestionJobAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CreateDataIngestionJobAsync (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class System.BinaryData>> CreateDataIngestionJobAsync(valuetype Azure.WaitUntil waitUntil, string jobId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.CreateDataIngestionJobAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateDataIngestionJobAsync (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member CreateDataIngestionJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CreateDataIngestionJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="weather.CreateDataIngestionJobAsync (waitUntil, jobId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="jobId"> Job id supplied by user. </param> <param name="content"> The content to send as the body of the request. Details of the request body schema are in the Remarks section below. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Create a weather data ingestion job. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the request and response payloads. Request Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code> Response Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateDataIngestionJobAsync with required parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { boundaryId = "<boundaryId>", partyId = "<partyId>", extensionId = "<extensionId>", extensionApiName = "<extensionApiName>", extensionApiInput = new { key = new {}, }, }; var operation = await client.CreateDataIngestionJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); ]]></code> This sample shows how to call CreateDataIngestionJobAsync with all parameters and request content, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); var data = new { boundaryId = "<boundaryId>", partyId = "<partyId>", extensionId = "<extensionId>", extensionApiName = "<extensionApiName>", extensionApiInput = new { key = new {}, }, extensionDataProviderAppId = "<extensionDataProviderAppId>", extensionDataProviderApiKey = "<extensionDataProviderApiKey>", name = "<name>", description = "<description>", properties = new { key = new {}, }, }; var operation = await client.CreateDataIngestionJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data)); BinaryData data = operation.Value; JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderAppId").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderApiKey").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDataDeleteJobDetails"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetDataDeleteJobDetails (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDataDeleteJobDetails(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetDataDeleteJobDetails(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataDeleteJobDetails (jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetDataDeleteJobDetails : string * Azure.RequestContext -> Azure.Response
override this.GetDataDeleteJobDetails : string * Azure.RequestContext -> Azure.Response" Usage="weather.GetDataDeleteJobDetails (jobId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> Id of the job. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Get weather data delete job. </summary> <returns> The response returned from the service. Details of the response body schema are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Response Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDataDeleteJobDetails with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); Response response = client.GetDataDeleteJobDetails("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("endDateTime").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDataDeleteJobDetailsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDataDeleteJobDetailsAsync (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDataDeleteJobDetailsAsync(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetDataDeleteJobDetailsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataDeleteJobDetailsAsync (jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetDataDeleteJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDataDeleteJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="weather.GetDataDeleteJobDetailsAsync (jobId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> Id of the job. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Get weather data delete job. </summary> <returns> The response returned from the service. Details of the response body schema are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Response Body: Schema for <c>WeatherDataDeleteJob</c>: <code>{ extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. partyId: string, # Required. The id of the party for which weather data is being fetched. boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. weatherDataType: string, # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. granularity: string, # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. startDateTime: string (ISO 8601 Format), # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. endDateTime: string (ISO 8601 Format), # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDataDeleteJobDetailsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); Response response = await client.GetDataDeleteJobDetailsAsync("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("endDateTime").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDataIngestionJobDetails"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetDataIngestionJobDetails (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDataIngestionJobDetails(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetDataIngestionJobDetails(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataIngestionJobDetails (jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetDataIngestionJobDetails : string * Azure.RequestContext -> Azure.Response
override this.GetDataIngestionJobDetails : string * Azure.RequestContext -> Azure.Response" Usage="weather.GetDataIngestionJobDetails (jobId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> Id of the job. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Get weather ingestion job. </summary> <returns> The response returned from the service. Details of the response body schema are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Response Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDataIngestionJobDetails with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); Response response = client.GetDataIngestionJobDetails("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderAppId").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderApiKey").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDataIngestionJobDetailsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDataIngestionJobDetailsAsync (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDataIngestionJobDetailsAsync(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetDataIngestionJobDetailsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDataIngestionJobDetailsAsync (jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetDataIngestionJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDataIngestionJobDetailsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="weather.GetDataIngestionJobDetailsAsync (jobId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> Id of the job. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Get weather ingestion job. </summary> <returns> The response returned from the service. Details of the response body schema are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Response Body: Schema for <c>WeatherDataIngestionJob</c>: <code>{ boundaryId: string, # Required. The id of the boundary object for which weather data is being fetched. partyId: string, # Required. The id of the party for which weather data is being fetched. extensionId: string, # Required. Id of the extension to be used for the providerInput. eg. DTN.ClearAg. extensionApiName: string, # Required. Extension api name to which request is to be made. extensionApiInput: Dictionary<string, any>, # Required. Extension api input dictionary which would be used to feed request query/body/parameter information. extensionDataProviderAppId: string, # Optional. App id of the weather data provider. extensionDataProviderApiKey: string, # Optional. Api key of the weather data provider. 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. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDataIngestionJobDetailsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); Response response = await client.GetDataIngestionJobDetailsAsync("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("extensionApiName").ToString()); Console.WriteLine(result.GetProperty("extensionApiInput").GetProperty("<test>").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderAppId").ToString()); Console.WriteLine(result.GetProperty("extensionDataProviderApiKey").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetWeathers"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetWeathers (string partyId, string boundaryId, string extensionId, string weatherDataType, string granularity, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetWeathers(string partyId, string boundaryId, string extensionId, string weatherDataType, string granularity, valuetype System.Nullable`1<valuetype System.DateTimeOffset> startDateTime, valuetype System.Nullable`1<valuetype System.DateTimeOffset> endDateTime, valuetype System.Nullable`1<int32> maxPageSize, string skipToken, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetWeathers(System.String,System.String,System.String,System.String,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.Int32},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetWeathers (partyId As String, boundaryId As String, extensionId As String, weatherDataType As String, granularity As String, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetWeathers : string * string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetWeathers : string * string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="weather.GetWeathers (partyId, boundaryId, extensionId, weatherDataType, granularity, startDateTime, endDateTime, maxPageSize, skipToken, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="partyId" Type="System.String" /> <Parameter Name="boundaryId" Type="System.String" /> <Parameter Name="extensionId" Type="System.String" /> <Parameter Name="weatherDataType" Type="System.String" /> <Parameter Name="granularity" Type="System.String" /> <Parameter Name="startDateTime" Type="System.Nullable<System.DateTimeOffset>" /> <Parameter Name="endDateTime" Type="System.Nullable<System.DateTimeOffset>" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="skipToken" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="partyId"> Party ID. </param> <param name="boundaryId"> Boundary ID. </param> <param name="extensionId"> ID of the weather extension. </param> <param name="weatherDataType"> Type of weather data (forecast/historical). </param> <param name="granularity"> Granularity of weather data (daily/hourly). </param> <param name="startDateTime"> Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. </param> <param name="endDateTime"> Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. </param> <param name="maxPageSize"> Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. </param> <param name="skipToken"> Skip token for getting next set of results. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Returns a paginated list of weather data. </summary> <returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Below is the JSON schema for one item in the pageable response. Response Body: Schema for <c>WeatherDataListResponseValue</c>: <code>{ partyId: string, # Required. Party ID. boundaryId: string, # Required. Boundary ID. extensionId: string, # Required. ID of the weather extension. location: { latitude: number, # Required. Latitude of the location. longitude: number, # Required. Longitude of the location. }, # Required. Location model class. dateTime: string (ISO 8601 Format), # Required. Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. unitSystemCode: string, # Optional. Unit System like US/SI etc. extensionVersion: string, # Required. Version of the weather data extension. weatherDataType: string, # Required. Type of weather data (forecast/historical). granularity: string, # Required. Granularity of weather data (daily/hourly). cloudCover: { unit: string, # Optional. Data unit. value: number, # Optional. Data value. }, # Optional. Schema for storing measurement reading and unit. dewPoint: Measure, # Optional. Schema for storing measurement reading and unit. growingDegreeDay: Measure, # Optional. Schema for storing measurement reading and unit. precipitation: Measure, # Optional. Schema for storing measurement reading and unit. pressure: Measure, # Optional. Schema for storing measurement reading and unit. relativeHumidity: Measure, # Optional. Schema for storing measurement reading and unit. soilMoisture: Measure, # Optional. Schema for storing measurement reading and unit. soilTemperature: Measure, # Optional. Schema for storing measurement reading and unit. temperature: Measure, # Optional. Schema for storing measurement reading and unit. visibility: Measure, # Optional. Schema for storing measurement reading and unit. wetBulbTemperature: Measure, # Optional. Schema for storing measurement reading and unit. windChill: Measure, # Optional. Schema for storing measurement reading and unit. windDirection: Measure, # Optional. Schema for storing measurement reading and unit. windGust: Measure, # Optional. Schema for storing measurement reading and unit. windSpeed: Measure, # Optional. Schema for storing measurement reading and unit. id: string, # Optional. Weather data ID. eTag: string, # Optional. The ETag value to implement optimistic concurrency. 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. 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 250 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="partyId" />, <paramref name="boundaryId" />, <paramref name="extensionId" />, <paramref name="weatherDataType" /> or <paramref name="granularity" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetWeathers with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); foreach (var data in client.GetWeathers("<partyId>", "<boundaryId>", "<extensionId>", "<weatherDataType>", "<granularity>")) { JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("latitude").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("longitude").ToString()); Console.WriteLine(result.GetProperty("dateTime").ToString()); Console.WriteLine(result.GetProperty("extensionVersion").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); } ]]></code> This sample shows how to call GetWeathers with all parameters, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); foreach (var data in client.GetWeathers("<partyId>", "<boundaryId>", "<extensionId>", "<weatherDataType>", "<granularity>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, "<skipToken>")) { JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("latitude").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("longitude").ToString()); Console.WriteLine(result.GetProperty("dateTime").ToString()); Console.WriteLine(result.GetProperty("unitSystemCode").ToString()); Console.WriteLine(result.GetProperty("extensionVersion").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("cloudCover").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("cloudCover").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("dewPoint").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("dewPoint").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("growingDegreeDay").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("growingDegreeDay").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("precipitation").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("precipitation").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("pressure").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("pressure").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("relativeHumidity").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("relativeHumidity").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("soilMoisture").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("soilMoisture").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("soilTemperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("soilTemperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("temperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("temperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("visibility").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("visibility").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("wetBulbTemperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("wetBulbTemperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windChill").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windChill").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windDirection").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windDirection").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windGust").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windGust").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windSpeed").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windSpeed").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("eTag").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("modifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetWeathersAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetWeathersAsync (string partyId, string boundaryId, string extensionId, string weatherDataType, string granularity, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetWeathersAsync(string partyId, string boundaryId, string extensionId, string weatherDataType, string granularity, valuetype System.Nullable`1<valuetype System.DateTimeOffset> startDateTime, valuetype System.Nullable`1<valuetype System.DateTimeOffset> endDateTime, valuetype System.Nullable`1<int32> maxPageSize, string skipToken, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Verticals.AgriFood.Farming.Weather.GetWeathersAsync(System.String,System.String,System.String,System.String,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.Int32},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetWeathersAsync (partyId As String, boundaryId As String, extensionId As String, weatherDataType As String, granularity As String, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime 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)" /> <MemberSignature Language="F#" Value="abstract member GetWeathersAsync : string * string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetWeathersAsync : string * string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="weather.GetWeathersAsync (partyId, boundaryId, extensionId, weatherDataType, granularity, startDateTime, endDateTime, maxPageSize, skipToken, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="partyId" Type="System.String" /> <Parameter Name="boundaryId" Type="System.String" /> <Parameter Name="extensionId" Type="System.String" /> <Parameter Name="weatherDataType" Type="System.String" /> <Parameter Name="granularity" Type="System.String" /> <Parameter Name="startDateTime" Type="System.Nullable<System.DateTimeOffset>" /> <Parameter Name="endDateTime" Type="System.Nullable<System.DateTimeOffset>" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="skipToken" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="partyId"> Party ID. </param> <param name="boundaryId"> Boundary ID. </param> <param name="extensionId"> ID of the weather extension. </param> <param name="weatherDataType"> Type of weather data (forecast/historical). </param> <param name="granularity"> Granularity of weather data (daily/hourly). </param> <param name="startDateTime"> Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. </param> <param name="endDateTime"> Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. </param> <param name="maxPageSize"> Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. </param> <param name="skipToken"> Skip token for getting next set of results. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Returns a paginated list of weather data. </summary> <returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Below is the JSON schema for one item in the pageable response. Response Body: Schema for <c>WeatherDataListResponseValue</c>: <code>{ partyId: string, # Required. Party ID. boundaryId: string, # Required. Boundary ID. extensionId: string, # Required. ID of the weather extension. location: { latitude: number, # Required. Latitude of the location. longitude: number, # Required. Longitude of the location. }, # Required. Location model class. dateTime: string (ISO 8601 Format), # Required. Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. unitSystemCode: string, # Optional. Unit System like US/SI etc. extensionVersion: string, # Required. Version of the weather data extension. weatherDataType: string, # Required. Type of weather data (forecast/historical). granularity: string, # Required. Granularity of weather data (daily/hourly). cloudCover: { unit: string, # Optional. Data unit. value: number, # Optional. Data value. }, # Optional. Schema for storing measurement reading and unit. dewPoint: Measure, # Optional. Schema for storing measurement reading and unit. growingDegreeDay: Measure, # Optional. Schema for storing measurement reading and unit. precipitation: Measure, # Optional. Schema for storing measurement reading and unit. pressure: Measure, # Optional. Schema for storing measurement reading and unit. relativeHumidity: Measure, # Optional. Schema for storing measurement reading and unit. soilMoisture: Measure, # Optional. Schema for storing measurement reading and unit. soilTemperature: Measure, # Optional. Schema for storing measurement reading and unit. temperature: Measure, # Optional. Schema for storing measurement reading and unit. visibility: Measure, # Optional. Schema for storing measurement reading and unit. wetBulbTemperature: Measure, # Optional. Schema for storing measurement reading and unit. windChill: Measure, # Optional. Schema for storing measurement reading and unit. windDirection: Measure, # Optional. Schema for storing measurement reading and unit. windGust: Measure, # Optional. Schema for storing measurement reading and unit. windSpeed: Measure, # Optional. Schema for storing measurement reading and unit. id: string, # Optional. Weather data ID. eTag: string, # Optional. The ETag value to implement optimistic concurrency. 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. 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 250 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="partyId" />, <paramref name="boundaryId" />, <paramref name="extensionId" />, <paramref name="weatherDataType" /> or <paramref name="granularity" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetWeathersAsync with required parameters and parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); await foreach (var data in client.GetWeathersAsync("<partyId>", "<boundaryId>", "<extensionId>", "<weatherDataType>", "<granularity>")) { JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("latitude").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("longitude").ToString()); Console.WriteLine(result.GetProperty("dateTime").ToString()); Console.WriteLine(result.GetProperty("extensionVersion").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); } ]]></code> This sample shows how to call GetWeathersAsync with all parameters, and how to parse the result. <code><![CDATA[ var credential = new DefaultAzureCredential(); var client = new FarmBeatsClient(credential).GetWeatherClient(<2022-11-01-preview>); await foreach (var data in client.GetWeathersAsync("<partyId>", "<boundaryId>", "<extensionId>", "<weatherDataType>", "<granularity>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, "<skipToken>")) { JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("partyId").ToString()); Console.WriteLine(result.GetProperty("boundaryId").ToString()); Console.WriteLine(result.GetProperty("extensionId").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("latitude").ToString()); Console.WriteLine(result.GetProperty("location").GetProperty("longitude").ToString()); Console.WriteLine(result.GetProperty("dateTime").ToString()); Console.WriteLine(result.GetProperty("unitSystemCode").ToString()); Console.WriteLine(result.GetProperty("extensionVersion").ToString()); Console.WriteLine(result.GetProperty("weatherDataType").ToString()); Console.WriteLine(result.GetProperty("granularity").ToString()); Console.WriteLine(result.GetProperty("cloudCover").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("cloudCover").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("dewPoint").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("dewPoint").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("growingDegreeDay").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("growingDegreeDay").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("precipitation").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("precipitation").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("pressure").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("pressure").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("relativeHumidity").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("relativeHumidity").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("soilMoisture").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("soilMoisture").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("soilTemperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("soilTemperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("temperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("temperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("visibility").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("visibility").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("wetBulbTemperature").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("wetBulbTemperature").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windChill").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windChill").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windDirection").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windDirection").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windGust").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windGust").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("windSpeed").GetProperty("unit").ToString()); Console.WriteLine(result.GetProperty("windSpeed").GetProperty("value").ToString()); Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("eTag").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("modifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="Pipeline"> <MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" /> <MemberSignature Language="DocId" Value="P:Azure.Verticals.AgriFood.Farming.Weather.Pipeline" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" /> <MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Verticals.AgriFood.Farming.Weather.Pipeline" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Verticals.AgriFood.Farming</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType> </ReturnValue> <Docs> <summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Azure.Verticals.AgriFood.Farming/Weather.xml (1,407 lines of code) (raw):