Class NutrientAnalysesAsyncClient

java.lang.Object
com.azure.verticals.agrifood.farming.NutrientAnalysesAsyncClient

public final class NutrientAnalysesAsyncClient extends Object
Initializes a new instance of the asynchronous FarmBeatsClient type.
  • Method Summary

    Modifier and Type
    Method
    Description
    Mono<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.
    Mono<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.
    Mono<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.PagedFlux<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.PagedFlux<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.PagedFlux<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
      NameTypeRequiredDescription
      parentTypeStringNoType of the parent it belongs to. i.e. PlantTissueAnalysis.
      parentIdsList<String>NoParent ids of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      classificationsList<String>NoClassifications for nutrient analyses. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      idsList<String>NoIds of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      namesList<String>NoNames of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      propertyFiltersList<String>NoFilters 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.
      statusesList<String>NoStatuses of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      minCreatedDateTimeOffsetDateTimeNoMinimum creation date of resource (inclusive).
      maxCreatedDateTimeOffsetDateTimeNoMaximum creation date of resource (inclusive).
      minLastModifiedDateTimeOffsetDateTimeNoMinimum last modified date of resource (inclusive).
      maxLastModifiedDateTimeOffsetDateTimeNoMaximum last modified date of resource (inclusive).
      maxPageSizeIntegerNoMaximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
      skipTokenStringNoSkip 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 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.
    • 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 nutrient analysis resources under a particular party.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      parentTypeStringNoType of the parent it belongs to. i.e. PlantTissueAnalysis.
      parentIdsList<String>NoParent ids of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      classificationsList<String>NoClassifications for nutrient analyses. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      idsList<String>NoIds of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      namesList<String>NoNames of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      propertyFiltersList<String>NoFilters 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.
      statusesList<String>NoStatuses of the resource. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      minCreatedDateTimeOffsetDateTimeNoMinimum creation date of resource (inclusive).
      maxCreatedDateTimeOffsetDateTimeNoMaximum creation date of resource (inclusive).
      minLastModifiedDateTimeOffsetDateTimeNoMinimum last modified date of resource (inclusive).
      maxLastModifiedDateTimeOffsetDateTimeNoMaximum last modified date of resource (inclusive).
      maxPageSizeIntegerNoMaximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
      skipTokenStringNoSkip 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 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 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 on successful completion of Mono.
      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 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 on successful completion of Mono.
      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 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 on successful completion of Mono.
      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.