Class HarvestDataAsyncClient
java.lang.Object
com.azure.verticals.agrifood.farming.HarvestDataAsyncClient
Initializes a new instance of the asynchronous FarmBeatsClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,
com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob
(String jobId, String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Create cascade delete job for harvest data resource.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
createOrUpdateWithResponse
(String partyId, String harvestDataId, com.azure.core.util.BinaryData harvestData, com.azure.core.http.rest.RequestOptions requestOptions) Creates or updates harvest data resource under a particular party.deleteWithResponse
(String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Deletes a specified harvest data resource under a particular party.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getCascadeDeleteJobDetailsWithResponse
(String jobId, com.azure.core.http.rest.RequestOptions requestOptions) Get cascade delete job for harvest data resource.Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
getWithResponse
(String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Get a specified harvest data resource under a particular party.com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>
list
(com.azure.core.http.rest.RequestOptions requestOptions) Returns a paginated list of harvest data resources across all parties.com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>
listByPartyId
(String partyId, com.azure.core.http.rest.RequestOptions requestOptions) Returns a paginated list of harvest data resources under a particular farm.
-
Method Details
-
list
public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> list(com.azure.core.http.rest.RequestOptions requestOptions) Returns a paginated list of harvest data resources across all parties.Query Parameters
Query Parameters Name Type Required Description minTotalYield Double No Minimum Yield value(inclusive). maxTotalYield Double No Maximum Yield value (inclusive). minAvgYield Double No Minimum AvgYield value(inclusive). maxAvgYield Double No Maximum AvgYield value (inclusive). minTotalWetMass Double No Minimum Total WetMass value(inclusive). maxTotalWetMass Double No Maximum Total WetMass value (inclusive). minAvgWetMass Double No Minimum AvgWetMass value(inclusive). maxAvgWetMass Double No Maximum AvgWetMass value (inclusive). minAvgMoisture Double No Minimum AvgMoisture value(inclusive). maxAvgMoisture Double No Maximum AvgMoisture value (inclusive). minAvgSpeed Double No Minimum AvgSpeed value(inclusive). maxAvgSpeed Double No Maximum AvgSpeed value (inclusive). sources List<String> No Sources of the operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.associatedBoundaryIds List<String> No Boundary IDs associated with operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.minOperationStartDateTime OffsetDateTime No Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationStartDateTime OffsetDateTime No Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minOperationEndDateTime OffsetDateTime No Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationEndDateTime OffsetDateTime No Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minOperationModifiedDateTime OffsetDateTime No Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationModifiedDateTime OffsetDateTime No Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minArea Double No Minimum area for which operation was applied (inclusive). maxArea Double No Maximum area for which operation was applied (inclusive). ids List<String> No Ids of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.names List<String> No Names of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.propertyFilters List<String> No Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.statuses List<String> No Statuses of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.minCreatedDateTime OffsetDateTime No Minimum creation date of resource (inclusive). maxCreatedDateTime OffsetDateTime No Maximum creation date of resource (inclusive). minLastModifiedDateTime OffsetDateTime No Minimum last modified date of resource (inclusive). maxLastModifiedDateTime OffsetDateTime No Maximum last modified date of resource (inclusive). maxPageSize Integer No Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. skipToken String No Skip token for getting next set of results. RequestOptions.addQueryParam(java.lang.String, java.lang.String)
Response Body Schema
{ totalYield (Optional): { unit: String (Optional) value: Double (Optional) } avgYield (Optional): (recursive schema, see avgYield above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) avgMoisture (Optional): (recursive schema, see avgMoisture above) avgSpeed (Optional): (recursive schema, see avgSpeed above) harvestProductDetails (Optional): [ (Optional){ productName: String (Optional) area (Optional): (recursive schema, see area above) totalYield (Optional): (recursive schema, see totalYield above) avgYield (Optional): (recursive schema, see avgYield above) avgMoisture (Optional): (recursive schema, see avgMoisture above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) } ] area (Optional): (recursive schema, see area above) operationModifiedDateTime: OffsetDateTime (Optional) operationStartDateTime: OffsetDateTime (Optional) operationEndDateTime: OffsetDateTime (Optional) attachmentsLink: String (Optional) associatedBoundaryId: String (Optional) partyId: String (Optional) id: String (Optional) eTag: String (Optional) status: String (Optional) createdDateTime: OffsetDateTime (Optional) modifiedDateTime: OffsetDateTime (Optional) source: String (Optional) name: String (Optional) description: String (Optional) createdBy: String (Optional) modifiedBy: String (Optional) properties (Optional): { String: Object (Optional) } }
- Parameters:
requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- paged response contains list of requested objects and a URL link to get the next set of results as
paginated response with
PagedFlux
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
beginCreateCascadeDeleteJob
public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Create cascade delete job for harvest data resource.Response Body Schema
{ partyId: String (Required) resourceId: String (Required) resourceType: String (Required) id: String (Optional) status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional) durationInSeconds: Double (Optional) message: String (Optional) errorCode: String (Optional) createdDateTime: OffsetDateTime (Optional) lastActionDateTime: OffsetDateTime (Optional) startTime: OffsetDateTime (Optional) endTime: OffsetDateTime (Optional) }
- Parameters:
jobId
- Job Id supplied by end user.partyId
- Id of the party.harvestDataId
- Id of the harvest data.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
PollerFlux
for polling of schema of cascade delete job. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getCascadeDeleteJobDetailsWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCascadeDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions) Get cascade delete job for harvest data resource.Response Body Schema
{ partyId: String (Required) resourceId: String (Required) resourceType: String (Required) id: String (Optional) status: String(Waiting/Running/Succeeded/Failed/Cancelled) (Optional) durationInSeconds: Double (Optional) message: String (Optional) errorCode: String (Optional) createdDateTime: OffsetDateTime (Optional) lastActionDateTime: OffsetDateTime (Optional) startTime: OffsetDateTime (Optional) endTime: OffsetDateTime (Optional) }
- Parameters:
jobId
- Id of the job.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- cascade delete job for harvest data resource along with
Response
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
listByPartyId
public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listByPartyId(String partyId, com.azure.core.http.rest.RequestOptions requestOptions) Returns a paginated list of harvest data resources under a particular farm.Query Parameters
Query Parameters Name Type Required Description minTotalYield Double No Minimum Yield value(inclusive). maxTotalYield Double No Maximum Yield value (inclusive). minAvgYield Double No Minimum AvgYield value(inclusive). maxAvgYield Double No Maximum AvgYield value (inclusive). minTotalWetMass Double No Minimum Total WetMass value(inclusive). maxTotalWetMass Double No Maximum Total WetMass value (inclusive). minAvgWetMass Double No Minimum AvgWetMass value(inclusive). maxAvgWetMass Double No Maximum AvgWetMass value (inclusive). minAvgMoisture Double No Minimum AvgMoisture value(inclusive). maxAvgMoisture Double No Maximum AvgMoisture value (inclusive). minAvgSpeed Double No Minimum AvgSpeed value(inclusive). maxAvgSpeed Double No Maximum AvgSpeed value (inclusive). sources List<String> No Sources of the operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.associatedBoundaryIds List<String> No Boundary IDs associated with operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.minOperationStartDateTime OffsetDateTime No Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationStartDateTime OffsetDateTime No Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minOperationEndDateTime OffsetDateTime No Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationEndDateTime OffsetDateTime No Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minOperationModifiedDateTime OffsetDateTime No Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). maxOperationModifiedDateTime OffsetDateTime No Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). minArea Double No Minimum area for which operation was applied (inclusive). maxArea Double No Maximum area for which operation was applied (inclusive). ids List<String> No Ids of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.names List<String> No Names of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.propertyFilters List<String> No Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.statuses List<String> No Statuses of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.minCreatedDateTime OffsetDateTime No Minimum creation date of resource (inclusive). maxCreatedDateTime OffsetDateTime No Maximum creation date of resource (inclusive). minLastModifiedDateTime OffsetDateTime No Minimum last modified date of resource (inclusive). maxLastModifiedDateTime OffsetDateTime No Maximum last modified date of resource (inclusive). maxPageSize Integer No Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. skipToken String No Skip token for getting next set of results. RequestOptions.addQueryParam(java.lang.String, java.lang.String)
Response Body Schema
{ totalYield (Optional): { unit: String (Optional) value: Double (Optional) } avgYield (Optional): (recursive schema, see avgYield above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) avgMoisture (Optional): (recursive schema, see avgMoisture above) avgSpeed (Optional): (recursive schema, see avgSpeed above) harvestProductDetails (Optional): [ (Optional){ productName: String (Optional) area (Optional): (recursive schema, see area above) totalYield (Optional): (recursive schema, see totalYield above) avgYield (Optional): (recursive schema, see avgYield above) avgMoisture (Optional): (recursive schema, see avgMoisture above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) } ] area (Optional): (recursive schema, see area above) operationModifiedDateTime: OffsetDateTime (Optional) operationStartDateTime: OffsetDateTime (Optional) operationEndDateTime: OffsetDateTime (Optional) attachmentsLink: String (Optional) associatedBoundaryId: String (Optional) partyId: String (Optional) id: String (Optional) eTag: String (Optional) status: String (Optional) createdDateTime: OffsetDateTime (Optional) modifiedDateTime: OffsetDateTime (Optional) source: String (Optional) name: String (Optional) description: String (Optional) createdBy: String (Optional) modifiedBy: String (Optional) properties (Optional): { String: Object (Optional) } }
- Parameters:
partyId
- ID of the associated party.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- paged response contains list of requested objects and a URL link to get the next set of results as
paginated response with
PagedFlux
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getWithResponse(String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Get a specified harvest data resource under a particular party.Response Body Schema
{ totalYield (Optional): { unit: String (Optional) value: Double (Optional) } avgYield (Optional): (recursive schema, see avgYield above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) avgMoisture (Optional): (recursive schema, see avgMoisture above) avgSpeed (Optional): (recursive schema, see avgSpeed above) harvestProductDetails (Optional): [ (Optional){ productName: String (Optional) area (Optional): (recursive schema, see area above) totalYield (Optional): (recursive schema, see totalYield above) avgYield (Optional): (recursive schema, see avgYield above) avgMoisture (Optional): (recursive schema, see avgMoisture above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) } ] area (Optional): (recursive schema, see area above) operationModifiedDateTime: OffsetDateTime (Optional) operationStartDateTime: OffsetDateTime (Optional) operationEndDateTime: OffsetDateTime (Optional) attachmentsLink: String (Optional) associatedBoundaryId: String (Optional) partyId: String (Optional) id: String (Optional) eTag: String (Optional) status: String (Optional) createdDateTime: OffsetDateTime (Optional) modifiedDateTime: OffsetDateTime (Optional) source: String (Optional) name: String (Optional) description: String (Optional) createdBy: String (Optional) modifiedBy: String (Optional) properties (Optional): { String: Object (Optional) } }
- Parameters:
partyId
- ID of the associated party resource.harvestDataId
- ID of the harvest data resource.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- a specified harvest data resource under a particular party along with
Response
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
createOrUpdateWithResponse
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateWithResponse(String partyId, String harvestDataId, com.azure.core.util.BinaryData harvestData, com.azure.core.http.rest.RequestOptions requestOptions) Creates or updates harvest data resource under a particular party.Request Body Schema
{ totalYield (Optional): { unit: String (Optional) value: Double (Optional) } avgYield (Optional): (recursive schema, see avgYield above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) avgMoisture (Optional): (recursive schema, see avgMoisture above) avgSpeed (Optional): (recursive schema, see avgSpeed above) harvestProductDetails (Optional): [ (Optional){ productName: String (Optional) area (Optional): (recursive schema, see area above) totalYield (Optional): (recursive schema, see totalYield above) avgYield (Optional): (recursive schema, see avgYield above) avgMoisture (Optional): (recursive schema, see avgMoisture above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) } ] area (Optional): (recursive schema, see area above) operationModifiedDateTime: OffsetDateTime (Optional) operationStartDateTime: OffsetDateTime (Optional) operationEndDateTime: OffsetDateTime (Optional) attachmentsLink: String (Optional) associatedBoundaryId: String (Optional) partyId: String (Optional) id: String (Optional) eTag: String (Optional) status: String (Optional) createdDateTime: OffsetDateTime (Optional) modifiedDateTime: OffsetDateTime (Optional) source: String (Optional) name: String (Optional) description: String (Optional) createdBy: String (Optional) modifiedBy: String (Optional) properties (Optional): { String: Object (Optional) } }
Response Body Schema
{ totalYield (Optional): { unit: String (Optional) value: Double (Optional) } avgYield (Optional): (recursive schema, see avgYield above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) avgMoisture (Optional): (recursive schema, see avgMoisture above) avgSpeed (Optional): (recursive schema, see avgSpeed above) harvestProductDetails (Optional): [ (Optional){ productName: String (Optional) area (Optional): (recursive schema, see area above) totalYield (Optional): (recursive schema, see totalYield above) avgYield (Optional): (recursive schema, see avgYield above) avgMoisture (Optional): (recursive schema, see avgMoisture above) totalWetMass (Optional): (recursive schema, see totalWetMass above) avgWetMass (Optional): (recursive schema, see avgWetMass above) } ] area (Optional): (recursive schema, see area above) operationModifiedDateTime: OffsetDateTime (Optional) operationStartDateTime: OffsetDateTime (Optional) operationEndDateTime: OffsetDateTime (Optional) attachmentsLink: String (Optional) associatedBoundaryId: String (Optional) partyId: String (Optional) id: String (Optional) eTag: String (Optional) status: String (Optional) createdDateTime: OffsetDateTime (Optional) modifiedDateTime: OffsetDateTime (Optional) source: String (Optional) name: String (Optional) description: String (Optional) createdBy: String (Optional) modifiedBy: String (Optional) properties (Optional): { String: Object (Optional) } }
- Parameters:
partyId
- ID of the party.harvestDataId
- ID of the harvest data resource.harvestData
- Harvest data resource payload to create or update.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- schema of harvest data resource along with
Response
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
deleteWithResponse
public Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponse(String partyId, String harvestDataId, com.azure.core.http.rest.RequestOptions requestOptions) Deletes a specified harvest data resource under a particular party.- Parameters:
partyId
- ID of the associated party resource.harvestDataId
- ID of the harvest data.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
on successful completion ofMono
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-