com.azure.verticals.agrifood.farming.PlantingDataClient

public final class PlantingDataClient extends Object

Initializes a new instance of the synchronous FarmBeatsClient type.

Method Summary

Modifier and Type

Method

Description

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginCreateCascadeDeleteJob(String jobId, String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)

Create cascade delete job for planting data resource.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createOrUpdateWithResponse(String partyId, String plantingDataId, com.azure.core.util.BinaryData plantingData, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates an planting data resource under a particular party.

com.azure.core.http.rest.Response<Void>

deleteWithResponse(String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified planting data resource under a particular party.

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 planting data resource.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getWithResponse(String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)

Get a specified planting data resource under a particular party.

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

list(com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of planting data resources across all parties.

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

listByPartyId(String partyId, com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of planting data resources under a particular party.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listByPartyId

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listByPartyId(String partyId, com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of planting data resources under a particular party.

Query Parameters

Query Parameters
Name	Type	Required	Description
minAvgPlantingRate	Double	No	Minimum AvgPlantingRate value(inclusive).
maxAvgPlantingRate	Double	No	Maximum AvgPlantingRate value (inclusive).
minTotalMaterial	Double	No	Minimum TotalMaterial value(inclusive).
maxTotalMaterial	Double	No	Maximum TotalMaterial value (inclusive).
minAvgMaterial	Double	No	Minimum AvgMaterial value(inclusive).
maxAvgMaterial	Double	No	Maximum AvgMaterial 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.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema


 {
     avgPlantingRate (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     totalMaterial (Optional): (recursive schema, see totalMaterial above)
     avgMaterial (Optional): (recursive schema, see avgMaterial above)
     plantingProductDetails (Optional): [
          (Optional){
             productName: String (Optional)
             area (Optional): (recursive schema, see area above)
             totalMaterial (Optional): (recursive schema, see totalMaterial above)
             avgMaterial (Optional): (recursive schema, see avgMaterial 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 PagedIterable.
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 com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)

Get a specified planting data resource under a particular party.

Response Body Schema


 {
     avgPlantingRate (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     totalMaterial (Optional): (recursive schema, see totalMaterial above)
     avgMaterial (Optional): (recursive schema, see avgMaterial above)
     plantingProductDetails (Optional): [
          (Optional){
             productName: String (Optional)
             area (Optional): (recursive schema, see area above)
             totalMaterial (Optional): (recursive schema, see totalMaterial above)
             avgMaterial (Optional): (recursive schema, see avgMaterial 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.; plantingDataId - ID of the planting data resource.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a specified planting data resource under a particular party along with Response.
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 com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateWithResponse(String partyId, String plantingDataId, com.azure.core.util.BinaryData plantingData, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates an planting data resource under a particular party.

Request Body Schema


 {
     avgPlantingRate (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     totalMaterial (Optional): (recursive schema, see totalMaterial above)
     avgMaterial (Optional): (recursive schema, see avgMaterial above)
     plantingProductDetails (Optional): [
          (Optional){
             productName: String (Optional)
             area (Optional): (recursive schema, see area above)
             totalMaterial (Optional): (recursive schema, see totalMaterial above)
             avgMaterial (Optional): (recursive schema, see avgMaterial 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


 {
     avgPlantingRate (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     totalMaterial (Optional): (recursive schema, see totalMaterial above)
     avgMaterial (Optional): (recursive schema, see avgMaterial above)
     plantingProductDetails (Optional): [
          (Optional){
             productName: String (Optional)
             area (Optional): (recursive schema, see area above)
             totalMaterial (Optional): (recursive schema, see totalMaterial above)
             avgMaterial (Optional): (recursive schema, see avgMaterial 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.; plantingDataId - ID of the planting data resource.; plantingData - Planting data resource payload to create or update.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: schema of planting data resource along with Response.
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 com.azure.core.http.rest.Response<Void> deleteWithResponse(String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified planting data resource under a particular party.

Parameters:

partyId - ID of the associated party resource.

plantingDataId - ID of the planting data.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

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.

list

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> list(com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of planting data resources across all parties.

Query Parameters

Query Parameters
Name	Type	Required	Description
minAvgPlantingRate	Double	No	Minimum AvgPlantingRate value(inclusive).
maxAvgPlantingRate	Double	No	Maximum AvgPlantingRate value (inclusive).
minTotalMaterial	Double	No	Minimum TotalMaterial value(inclusive).
maxTotalMaterial	Double	No	Maximum TotalMaterial value (inclusive).
minAvgMaterial	Double	No	Minimum AvgMaterial value(inclusive).
maxAvgMaterial	Double	No	Maximum AvgMaterial 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.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema


 {
     avgPlantingRate (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     totalMaterial (Optional): (recursive schema, see totalMaterial above)
     avgMaterial (Optional): (recursive schema, see avgMaterial above)
     plantingProductDetails (Optional): [
          (Optional){
             productName: String (Optional)
             area (Optional): (recursive schema, see area above)
             totalMaterial (Optional): (recursive schema, see totalMaterial above)
             avgMaterial (Optional): (recursive schema, see avgMaterial 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 PagedIterable.
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.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String partyId, String plantingDataId, com.azure.core.http.rest.RequestOptions requestOptions)
Create cascade delete job for planting 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.

plantingDataId - Id of the planting data.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the SyncPoller 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 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 planting 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 planting data resource along with Response.

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.

Class PlantingDataClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

listByPartyId

getWithResponse

createOrUpdateWithResponse

deleteWithResponse

list

beginCreateCascadeDeleteJob

getCascadeDeleteJobDetailsWithResponse