Class OAuthProvidersAsyncClient

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

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

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginCreateCascadeDeleteJob(String jobId, String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
    Create cascade delete job for oauthProvider resource.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    createOrUpdateWithResponse(String oauthProviderId, com.azure.core.util.BinaryData oauthProvider, com.azure.core.http.rest.RequestOptions requestOptions)
    Creates or updates an oauthProvider resource.
    Mono<com.azure.core.http.rest.Response<Void>>
    deleteWithResponse(String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
    Deletes an specified oauthProvider resource.
    Mono<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 oauthProvider resource.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    getWithResponse(String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a specified oauthProvider resource.
    com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>
    list(com.azure.core.http.rest.RequestOptions requestOptions)
    Returns a paginated list of oauthProvider resources.

    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 oauthProvider resources.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      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

      
       {
           appId: String (Optional)
           appSecret: String (Optional)
           apiKey: String (Optional)
           isProductionApp: Boolean (Optional)
           id: String (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (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.
    • getWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getWithResponse(String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a specified oauthProvider resource.

      Response Body Schema

      
       {
           appId: String (Optional)
           appSecret: String (Optional)
           apiKey: String (Optional)
           isProductionApp: Boolean (Optional)
           id: String (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      oauthProviderId - ID of the oauthProvider resource.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a specified oauthProvider resource 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 oauthProviderId, com.azure.core.util.BinaryData oauthProvider, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or updates an oauthProvider resource.

      Request Body Schema

      
       {
           appId: String (Optional)
           appSecret: String (Optional)
           apiKey: String (Optional)
           isProductionApp: Boolean (Optional)
           id: String (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       

      Response Body Schema

      
       {
           appId: String (Optional)
           appSecret: String (Optional)
           apiKey: String (Optional)
           isProductionApp: Boolean (Optional)
           id: String (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      oauthProviderId - ID of oauthProvider resource.
      oauthProvider - OauthProvider resource payload to create or update.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      schema of OAuth provider resource 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 oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes an specified oauthProvider resource.
      Parameters:
      oauthProviderId - ID of oauthProvider.
      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.
    • getCascadeDeleteJobDetailsWithResponse

      public Mono<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 oauthProvider resource.

      Response Body Schema

      
       {
           oauthProviderId: String (Required)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (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 oauthProvider resource 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.
    • beginCreateCascadeDeleteJob

      public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
      Create cascade delete job for oauthProvider resource.

      Response Body Schema

      
       {
           oauthProviderId: String (Required)
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Job Id supplied by end user.
      oauthProviderId - Id of the application data.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the PollerFlux for polling of schema of oauth provider 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.