Class TillageDataClient

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

public final class TillageDataClient 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 tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
    Create cascade delete job for tillage data resource.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    createOrUpdateWithResponse(String partyId, String tillageDataId, com.azure.core.util.BinaryData tillageData, com.azure.core.http.rest.RequestOptions requestOptions)
    Creates or updates an tillage data resource under a particular party.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String partyId, String tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
    Deletes a specified tillage 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 tillage data resource.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getWithResponse(String partyId, String tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a specified tillage 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 tillage 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 tillage data resources under a particular farm.

    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 tillage data resources under a particular farm.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      minTillageDepthDoubleNoMinimum measured tillage depth (inclusive).
      maxTillageDepthDoubleNoMaximum measured tillage depth (inclusive).
      minTillagePressureDoubleNoMinimum pressure applied to a tillage implement (inclusive).
      maxTillagePressureDoubleNoMaximum pressure applied to a tillage implement (inclusive).
      sourcesList<String>NoSources of the operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      associatedBoundaryIdsList<String>NoBoundary IDs associated with operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      minOperationStartDateTimeOffsetDateTimeNoMinimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationStartDateTimeOffsetDateTimeNoMaximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minOperationEndDateTimeOffsetDateTimeNoMinimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationEndDateTimeOffsetDateTimeNoMaximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minOperationModifiedDateTimeOffsetDateTimeNoMinimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationModifiedDateTimeOffsetDateTimeNoMaximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minAreaDoubleNoMinimum area for which operation was applied (inclusive).
      maxAreaDoubleNoMaximum area for which operation was applied (inclusive).
      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

      
       {
           tillageDepth (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           tillagePressure (Optional): (recursive schema, see tillagePressure 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 tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a specified tillage data resource under a particular party.

      Response Body Schema

      
       {
           tillageDepth (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           tillagePressure (Optional): (recursive schema, see tillagePressure 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.
      tillageDataId - ID of the tillage data resource.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a specified tillage 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 tillageDataId, com.azure.core.util.BinaryData tillageData, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or updates an tillage data resource under a particular party.

      Request Body Schema

      
       {
           tillageDepth (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           tillagePressure (Optional): (recursive schema, see tillagePressure 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

      
       {
           tillageDepth (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           tillagePressure (Optional): (recursive schema, see tillagePressure 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.
      tillageDataId - ID of the tillage data resource.
      tillageData - Tillage data resource payload to create or update.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      schema of tillage 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 tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a specified tillage data resource under a particular party.
      Parameters:
      partyId - ID of the associated party resource.
      tillageDataId - ID of the tillage 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 tillage data resources across all parties.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      minTillageDepthDoubleNoMinimum measured tillage depth (inclusive).
      maxTillageDepthDoubleNoMaximum measured tillage depth (inclusive).
      minTillagePressureDoubleNoMinimum pressure applied to a tillage implement (inclusive).
      maxTillagePressureDoubleNoMaximum pressure applied to a tillage implement (inclusive).
      sourcesList<String>NoSources of the operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      associatedBoundaryIdsList<String>NoBoundary IDs associated with operation data. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      minOperationStartDateTimeOffsetDateTimeNoMinimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationStartDateTimeOffsetDateTimeNoMaximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minOperationEndDateTimeOffsetDateTimeNoMinimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationEndDateTimeOffsetDateTimeNoMaximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minOperationModifiedDateTimeOffsetDateTimeNoMinimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      maxOperationModifiedDateTimeOffsetDateTimeNoMaximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
      minAreaDoubleNoMinimum area for which operation was applied (inclusive).
      maxAreaDoubleNoMaximum area for which operation was applied (inclusive).
      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

      
       {
           tillageDepth (Optional): {
               unit: String (Optional)
               value: Double (Optional)
           }
           tillagePressure (Optional): (recursive schema, see tillagePressure 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 tillageDataId, com.azure.core.http.rest.RequestOptions requestOptions)
      Create cascade delete job for tillage 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.
      tillageDataId - Id of the tillage 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 tillage 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 tillage 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.