Class OAuthTokensClient

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

public final class OAuthTokensClient 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 oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
    Create remove job for OAuth token.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getCascadeDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get remove job for OAuth token.
    com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
    getOAuthConnectionLinkWithResponse(com.azure.core.util.BinaryData oauthConnectRequest, com.azure.core.http.rest.RequestOptions requestOptions)
    Returns Connection link needed in the OAuth flow.
    com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
    list(com.azure.core.http.rest.RequestOptions requestOptions)
    Returns a list of OAuthToken documents.

    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 list of OAuthToken documents.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      authProviderIdsList<String>NoName of AuthProvider. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      partyIdsList<String>NoList of parties. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      isValidBooleanNoIf the token object is valid.
      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 (Required)
           authProviderId: String (Required)
           isValid: Boolean (Optional)
           eTag: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           modifiedDateTime: OffsetDateTime (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.
    • getOAuthConnectionLinkWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getOAuthConnectionLinkWithResponse(com.azure.core.util.BinaryData oauthConnectRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns Connection link needed in the OAuth flow.

      Request Body Schema

      
       {
           partyId: String (Required)
           oAuthProviderId: String (Required)
           userRedirectLink: String (Required)
           userRedirectState: String (Optional)
       }
       

      Response Body Schema

      
       String
       
      Parameters:
      oauthConnectRequest - OAuth Connect Request.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body 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.
    • getCascadeDeleteJobDetailsWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCascadeDeleteJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get remove job for OAuth token.

      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:
      remove job for OAuth token 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.
    • beginCreateCascadeDeleteJob

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String partyId, String oauthProviderId, com.azure.core.http.rest.RequestOptions requestOptions)
      Create remove job for OAuth token.

      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.
      oauthProviderId - Id of the OAuthProvider.
      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.