com.azure.verticals.agrifood.farming.NutrientAnalysesClient

public final class NutrientAnalysesClient extends Object

Initializes a new instance of the synchronous FarmBeatsClient type.

Method Summary

Modifier and Type

Method

Description

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

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

Creates or updates a nutrient analysis resource.

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

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

Deletes a specified nutrient analysis resource under a particular party.

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

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

Gets a specified nutrient analysis 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 nutrient analysis 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 nutrient analysis 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

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 nutrient analysis resources across all parties.

Query Parameters

Query Parameters
Name	Type	Required	Description
parentType	String	No	Type of the parent it belongs to. i.e. PlantTissueAnalysis.
parentIds	List<String>	No	Parent ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
classifications	List<String>	No	Classifications for nutrient analyses. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
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


 {
     partyId: String (Optional)
     parentId: String (Optional)
     parentType: String(PlantTissueAnalysis) (Optional)
     unit: String (Optional)
     value: Double (Optional)
     referenceValueLow: Double (Optional)
     referenceValueHigh: Double (Optional)
     classification: String (Optional)
     recommendation: String (Optional)
     products (Optional): [
          (Optional){
             rate: String (Optional)
             instruction: String (Optional)
             product: 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.

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 nutrient analysis resources under a particular party.

Query Parameters

Query Parameters
Name	Type	Required	Description
parentType	String	No	Type of the parent it belongs to. i.e. PlantTissueAnalysis.
parentIds	List<String>	No	Parent ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
classifications	List<String>	No	Classifications for nutrient analyses. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
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


 {
     partyId: String (Optional)
     parentId: String (Optional)
     parentType: String(PlantTissueAnalysis) (Optional)
     unit: String (Optional)
     value: Double (Optional)
     referenceValueLow: Double (Optional)
     referenceValueHigh: Double (Optional)
     classification: String (Optional)
     recommendation: String (Optional)
     products (Optional): [
          (Optional){
             rate: String (Optional)
             instruction: String (Optional)
             product: 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 nutrientAnalysisId, com.azure.core.http.rest.RequestOptions requestOptions)
Gets a specified nutrient analysis resource under a particular party.
Response Body Schema
```
 {
     partyId: String (Optional)
     parentId: String (Optional)
     parentType: String(PlantTissueAnalysis) (Optional)
     unit: String (Optional)
     value: Double (Optional)
     referenceValueLow: Double (Optional)
     referenceValueHigh: Double (Optional)
     classification: String (Optional)
     recommendation: String (Optional)
     products (Optional): [
          (Optional){
             rate: String (Optional)
             instruction: String (Optional)
             product: 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.

nutrientAnalysisId - Id of the nutrient analysis.

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

Returns:

a specified nutrient analysis 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 nutrientAnalysisId, com.azure.core.util.BinaryData nutrientAnalysis, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates a nutrient analysis resource.

Request Body Schema


 {
     partyId: String (Optional)
     parentId: String (Optional)
     parentType: String(PlantTissueAnalysis) (Optional)
     unit: String (Optional)
     value: Double (Optional)
     referenceValueLow: Double (Optional)
     referenceValueHigh: Double (Optional)
     classification: String (Optional)
     recommendation: String (Optional)
     products (Optional): [
          (Optional){
             rate: String (Optional)
             instruction: String (Optional)
             product: 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


 {
     partyId: String (Optional)
     parentId: String (Optional)
     parentType: String(PlantTissueAnalysis) (Optional)
     unit: String (Optional)
     value: Double (Optional)
     referenceValueLow: Double (Optional)
     referenceValueHigh: Double (Optional)
     classification: String (Optional)
     recommendation: String (Optional)
     products (Optional): [
          (Optional){
             rate: String (Optional)
             instruction: String (Optional)
             product: 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 resource.; nutrientAnalysisId - Id of the nutrient analysis resource.; nutrientAnalysis - NutrientAnalysis resource payload to create or update.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: api Model for nutrient analysis object 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 nutrientAnalysisId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified nutrient analysis resource under a particular party.

Parameters:

partyId - Id of the party.

nutrientAnalysisId - Id of the nutrient analysis.

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.

Class NutrientAnalysesClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

list

listByPartyId

getWithResponse

createOrUpdateWithResponse

deleteWithResponse