Class SensorPartnerIntegrationsClient

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

public final class SensorPartnerIntegrationsClient 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>
    checkConsentWithResponse(String sensorPartnerId, String integrationId, String key, com.azure.core.http.rest.RequestOptions requestOptions)
    Checks consent for partner integration.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    createOrUpdateWithResponse(String sensorPartnerId, String integrationId, com.azure.core.util.BinaryData sensorPartnerIntegrationModel, com.azure.core.http.rest.RequestOptions requestOptions)
    Create or update an integration with a sensor partner.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
    Deletes a partner integration model entity.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    generateConsentLinkWithResponse(String sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
    Generates partner integration consent link.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getWithResponse(String sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
    Gets a partner integration model entity.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    list(String sensorPartnerId, com.azure.core.http.rest.RequestOptions requestOptions)
    Gets partner integration models.

    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(String sensorPartnerId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets partner integration models.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      integrationIdsList<String>NoIds of the partner integration models. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      partyIdsList<String>NoIds of the parties. 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

      
       {
           integrationId: String (Optional)
           partyId: String (Optional)
           sensorPartnerId: String (Optional)
           id: String (Optional)
           status: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           eTag: String (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      sensorPartnerId - Id of the associated sensor partner.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      partner integration models 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.
    • createOrUpdateWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateWithResponse(String sensorPartnerId, String integrationId, com.azure.core.util.BinaryData sensorPartnerIntegrationModel, com.azure.core.http.rest.RequestOptions requestOptions)
      Create or update an integration with a sensor partner.

      Request Body Schema

      
       {
           integrationId: String (Optional)
           partyId: String (Optional)
           sensorPartnerId: String (Optional)
           id: String (Optional)
           status: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           eTag: String (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       

      Response Body Schema

      
       {
           integrationId: String (Optional)
           partyId: String (Optional)
           sensorPartnerId: String (Optional)
           id: String (Optional)
           status: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           eTag: String (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      sensorPartnerId - Id of the sensor partner.
      integrationId - Id of the integration to be created.
      sensorPartnerIntegrationModel - Partner integration model.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      sensor partner integration model 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.
    • getWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets a partner integration model entity.

      Response Body Schema

      
       {
           integrationId: String (Optional)
           partyId: String (Optional)
           sensorPartnerId: String (Optional)
           id: String (Optional)
           status: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           eTag: String (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      sensorPartnerId - Id of the sensor partner.
      integrationId - Id of the integration object.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a partner integration model entity 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 sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a partner integration model entity.
      Parameters:
      sensorPartnerId - Id of the sensor partner.
      integrationId - Id of the integration to be deleted.
      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.
    • checkConsentWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> checkConsentWithResponse(String sensorPartnerId, String integrationId, String key, com.azure.core.http.rest.RequestOptions requestOptions)
      Checks consent for partner integration.

      Response Body Schema

      
       {
           consented: Boolean (Optional)
           sensorPartnerId: String (Optional)
           integrationId: String (Optional)
       }
       
      Parameters:
      sensorPartnerId - Id of the sensor partner.
      integrationId - Id of the integration object.
      key - Partner integration key.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      sensor partner integration check consent response 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.
    • generateConsentLinkWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> generateConsentLinkWithResponse(String sensorPartnerId, String integrationId, com.azure.core.http.rest.RequestOptions requestOptions)
      Generates partner integration consent link.

      Response Body Schema

      
       {
           consentLink: String (Optional)
           consentExpiryDateTime: OffsetDateTime (Optional)
       }
       
      Parameters:
      sensorPartnerId - Id of the sensor partner.
      integrationId - Id of the integration object.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      sensor partner integration generate consent link response 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.