Package com.azure.verticals.agrifood.farming

Class HarvestDataBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.HarvestDataBaseClient

public final class HarvestDataBaseClient
extends Object

Initializes a new instance of the HarvestDataBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createOrUpdate(String farmerId, String harvestDataId)	Creates or updates harvest data resource under a particular farmer.
DynamicRequest	delete(String farmerId, String harvestDataId)	Deletes a specified harvest data resource under a particular farmer.
DynamicRequest	get(String farmerId, String harvestDataId)	Get a specified harvest data resource under a particular farmer.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list()	Returns a paginated list of harvest data resources across all farmers.
DynamicRequest	listByFarmerId(String farmerId)	Returns a paginated list of harvest data resources under a particular farm.
DynamicRequest	listByFarmerIdNext(String nextLink)	Get the next page of items.
DynamicRequest	listNext(String nextLink)	Get the next page of items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listByFarmerId

public DynamicRequest listByFarmerId(String farmerId)

Returns a paginated list of harvest data resources under a particular farm.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
minTotalYield	Double	Minimum Yield value(inclusive).
maxTotalYield	Double	Maximum Yield value (inclusive).
minAvgYield	Double	Minimum AvgYield value(inclusive).
maxAvgYield	Double	Maximum AvgYield value (inclusive).
minTotalWetMass	Double	Minimum Total WetMass value(inclusive).
maxTotalWetMass	Double	Maximum Total WetMass value (inclusive).
minAvgWetMass	Double	Minimum AvgWetMass value(inclusive).
maxAvgWetMass	Double	Maximum AvgWetMass value (inclusive).
minAvgMoisture	Double	Minimum AvgMoisture value(inclusive).
maxAvgMoisture	Double	Maximum AvgMoisture value (inclusive).
minAvgSpeed	Double	Minimum AvgSpeed value(inclusive).
maxAvgSpeed	Double	Maximum AvgSpeed value (inclusive).
sources	List<String>	Sources of the operation data.
associatedBoundaryIds	List<String>	Boundary IDs associated with operation data.
operationBoundaryIds	List<String>	Operation boundary IDs associated with operation data.
minOperationStartDateTime	OffsetDateTime	Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationStartDateTime	OffsetDateTime	Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minOperationEndDateTime	OffsetDateTime	Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationEndDateTime	OffsetDateTime	Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minOperationModifiedDateTime	OffsetDateTime	Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationModifiedDateTime	OffsetDateTime	Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minArea	Double	Minimum area for which operation was applied (inclusive).
maxArea	Double	Maximum area for which operation was applied (inclusive).
ids	List<String>	Ids of the resource.
names	List<String>	Names of the resource.
propertyFilters	List<String>	Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".
statuses	List<String>	Statuses of the resource.
minCreatedDateTime	OffsetDateTime	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	Skip token for getting next set of results.

Response Body Schema

 {
     value: [
         {
             totalYield: {
                 unit: String
                 value: Double
             }
             avgYield: (recursive schema, see avgYield above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
             avgMoisture: (recursive schema, see avgMoisture above)
             avgSpeed: (recursive schema, see avgSpeed above)
             harvestProductDetails: [
                 {
                     productName: String
                     area: (recursive schema, see area above)
                     totalYield: (recursive schema, see totalYield above)
                     avgYield: (recursive schema, see avgYield above)
                     avgMoisture: (recursive schema, see avgMoisture above)
                     totalWetMass: (recursive schema, see totalWetMass above)
                     avgWetMass: (recursive schema, see avgWetMass above)
                 }
             ]
             area: (recursive schema, see area above)
             source: String
             operationModifiedDateTime: OffsetDateTime
             operationStartDateTime: OffsetDateTime
             operationEndDateTime: OffsetDateTime
             attachmentsLink: String
             associatedBoundaryId: String
             operationBoundaryId: String
             farmerId: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

farmerId - ID of the associated farmer.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

list

public DynamicRequest list()

Returns a paginated list of harvest data resources across all farmers.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
minTotalYield	Double	Minimum Yield value(inclusive).
maxTotalYield	Double	Maximum Yield value (inclusive).
minAvgYield	Double	Minimum AvgYield value(inclusive).
maxAvgYield	Double	Maximum AvgYield value (inclusive).
minTotalWetMass	Double	Minimum Total WetMass value(inclusive).
maxTotalWetMass	Double	Maximum Total WetMass value (inclusive).
minAvgWetMass	Double	Minimum AvgWetMass value(inclusive).
maxAvgWetMass	Double	Maximum AvgWetMass value (inclusive).
minAvgMoisture	Double	Minimum AvgMoisture value(inclusive).
maxAvgMoisture	Double	Maximum AvgMoisture value (inclusive).
minAvgSpeed	Double	Minimum AvgSpeed value(inclusive).
maxAvgSpeed	Double	Maximum AvgSpeed value (inclusive).
sources	List<String>	Sources of the operation data.
associatedBoundaryIds	List<String>	Boundary IDs associated with operation data.
operationBoundaryIds	List<String>	Operation boundary IDs associated with operation data.
minOperationStartDateTime	OffsetDateTime	Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationStartDateTime	OffsetDateTime	Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minOperationEndDateTime	OffsetDateTime	Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationEndDateTime	OffsetDateTime	Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minOperationModifiedDateTime	OffsetDateTime	Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
maxOperationModifiedDateTime	OffsetDateTime	Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
minArea	Double	Minimum area for which operation was applied (inclusive).
maxArea	Double	Maximum area for which operation was applied (inclusive).
ids	List<String>	Ids of the resource.
names	List<String>	Names of the resource.
propertyFilters	List<String>	Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".
statuses	List<String>	Statuses of the resource.
minCreatedDateTime	OffsetDateTime	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	Skip token for getting next set of results.

Response Body Schema

 {
     value: [
         {
             totalYield: {
                 unit: String
                 value: Double
             }
             avgYield: (recursive schema, see avgYield above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
             avgMoisture: (recursive schema, see avgMoisture above)
             avgSpeed: (recursive schema, see avgSpeed above)
             harvestProductDetails: [
                 {
                     productName: String
                     area: (recursive schema, see area above)
                     totalYield: (recursive schema, see totalYield above)
                     avgYield: (recursive schema, see avgYield above)
                     avgMoisture: (recursive schema, see avgMoisture above)
                     totalWetMass: (recursive schema, see totalWetMass above)
                     avgWetMass: (recursive schema, see avgWetMass above)
                 }
             ]
             area: (recursive schema, see area above)
             source: String
             operationModifiedDateTime: OffsetDateTime
             operationStartDateTime: OffsetDateTime
             operationEndDateTime: OffsetDateTime
             attachmentsLink: String
             associatedBoundaryId: String
             operationBoundaryId: String
             farmerId: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Returns:

a DynamicRequest where customizations can be made before sent to the service.

get

public DynamicRequest get(String farmerId,
 String harvestDataId)

Get a specified harvest data resource under a particular farmer.

Response Body Schema

 {
     totalYield: {
         unit: String
         value: Double
     }
     avgYield: (recursive schema, see avgYield above)
     totalWetMass: (recursive schema, see totalWetMass above)
     avgWetMass: (recursive schema, see avgWetMass above)
     avgMoisture: (recursive schema, see avgMoisture above)
     avgSpeed: (recursive schema, see avgSpeed above)
     harvestProductDetails: [
         {
             productName: String
             area: (recursive schema, see area above)
             totalYield: (recursive schema, see totalYield above)
             avgYield: (recursive schema, see avgYield above)
             avgMoisture: (recursive schema, see avgMoisture above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
         }
     ]
     area: (recursive schema, see area above)
     source: String
     operationModifiedDateTime: OffsetDateTime
     operationStartDateTime: OffsetDateTime
     operationEndDateTime: OffsetDateTime
     attachmentsLink: String
     associatedBoundaryId: String
     operationBoundaryId: String
     farmerId: String
     id: String
     eTag: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Parameters:

farmerId - ID of the associated farmer resource.

harvestDataId - ID of the harvest data resource.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

createOrUpdate

public DynamicRequest createOrUpdate(String farmerId,
 String harvestDataId)

Creates or updates harvest data resource under a particular farmer.

Request Body Schema

 {
     totalYield: {
         unit: String
         value: Double
     }
     avgYield: (recursive schema, see avgYield above)
     totalWetMass: (recursive schema, see totalWetMass above)
     avgWetMass: (recursive schema, see avgWetMass above)
     avgMoisture: (recursive schema, see avgMoisture above)
     avgSpeed: (recursive schema, see avgSpeed above)
     harvestProductDetails: [
         {
             productName: String
             area: (recursive schema, see area above)
             totalYield: (recursive schema, see totalYield above)
             avgYield: (recursive schema, see avgYield above)
             avgMoisture: (recursive schema, see avgMoisture above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
         }
     ]
     area: (recursive schema, see area above)
     source: String
     operationModifiedDateTime: OffsetDateTime
     operationStartDateTime: OffsetDateTime
     operationEndDateTime: OffsetDateTime
     attachmentsLink: String
     associatedBoundaryId: String
     operationBoundaryId: String
     farmerId: String
     id: String
     eTag: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Response Body Schema

 (recursive schema, see above)
 

Parameters:

farmerId - ID of the farmer.

harvestDataId - ID of the harvest data resource.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

delete

public DynamicRequest delete(String farmerId,
 String harvestDataId)

Deletes a specified harvest data resource under a particular farmer.

Parameters:

farmerId - ID of the associated farmer resource.

harvestDataId - ID of the harvest data.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

listByFarmerIdNext

public DynamicRequest listByFarmerIdNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             totalYield: {
                 unit: String
                 value: Double
             }
             avgYield: (recursive schema, see avgYield above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
             avgMoisture: (recursive schema, see avgMoisture above)
             avgSpeed: (recursive schema, see avgSpeed above)
             harvestProductDetails: [
                 {
                     productName: String
                     area: (recursive schema, see area above)
                     totalYield: (recursive schema, see totalYield above)
                     avgYield: (recursive schema, see avgYield above)
                     avgMoisture: (recursive schema, see avgMoisture above)
                     totalWetMass: (recursive schema, see totalWetMass above)
                     avgWetMass: (recursive schema, see avgWetMass above)
                 }
             ]
             area: (recursive schema, see area above)
             source: String
             operationModifiedDateTime: OffsetDateTime
             operationStartDateTime: OffsetDateTime
             operationEndDateTime: OffsetDateTime
             attachmentsLink: String
             associatedBoundaryId: String
             operationBoundaryId: String
             farmerId: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

nextLink - The nextLink parameter.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

listNext

public DynamicRequest listNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             totalYield: {
                 unit: String
                 value: Double
             }
             avgYield: (recursive schema, see avgYield above)
             totalWetMass: (recursive schema, see totalWetMass above)
             avgWetMass: (recursive schema, see avgWetMass above)
             avgMoisture: (recursive schema, see avgMoisture above)
             avgSpeed: (recursive schema, see avgSpeed above)
             harvestProductDetails: [
                 {
                     productName: String
                     area: (recursive schema, see area above)
                     totalYield: (recursive schema, see totalYield above)
                     avgYield: (recursive schema, see avgYield above)
                     avgMoisture: (recursive schema, see avgMoisture above)
                     totalWetMass: (recursive schema, see totalWetMass above)
                     avgWetMass: (recursive schema, see avgWetMass above)
                 }
             ]
             area: (recursive schema, see area above)
             source: String
             operationModifiedDateTime: OffsetDateTime
             operationStartDateTime: OffsetDateTime
             operationEndDateTime: OffsetDateTime
             attachmentsLink: String
             associatedBoundaryId: String
             operationBoundaryId: String
             farmerId: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

nextLink - The nextLink parameter.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

invoke

public DynamicRequest invoke()

Create an empty DynamicRequest with the serializer and pipeline initialized for this client.

Returns:

a DynamicRequest where customizations can be made before sent to the service.