Package com.azure.verticals.agrifood.farming

Class OAuthTokensBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.OAuthTokensBaseClient

public final class OAuthTokensBaseClient
extends Object

Initializes a new instance of the OAuthTokensBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createCascadeDeleteJob(String jobId, String farmerId, String oauthProviderId)	Create a cascade delete job for OAuth tokens.
DynamicRequest	getCascadeDeleteJobDetails(String jobId)	Get cascade delete job details for OAuth tokens for specified job ID.
DynamicRequest	getOAuthConnectionLink()	Returns Connection link needed in the OAuth flow.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list()	Returns a list of OAuthToken documents.
DynamicRequest	listNext(String nextLink)	Get the next page of items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

list

public DynamicRequest list()

Returns a list of OAuthToken documents.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
authProviderIds	List<String>	Name of AuthProvider.
farmerIds	List<String>	List of farmers.
isValid	Boolean	If the token object is valid.
minCreatedDateTime	OffsetDateTime	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	Skip token for getting next set of results.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             authProviderId: String
             isValid: Boolean
             eTag: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Returns:

a DynamicRequest where customizations can be made before sent to the service.

getOAuthConnectionLink

public DynamicRequest getOAuthConnectionLink()

Returns Connection link needed in the OAuth flow.

Request Body Schema

 {
     farmerId: String
     oAuthProviderId: String
     userRedirectLink: String
     userRedirectState: String
 }
 

Response Body Schema

 String
 

Returns:

a DynamicRequest where customizations can be made before sent to the service.

getCascadeDeleteJobDetails

public DynamicRequest getCascadeDeleteJobDetails(String jobId)

Get cascade delete job details for OAuth tokens for specified job ID.

Response Body Schema

 {
     farmerId: String
     resourceId: String
     resourceType: String
     id: String
     status: String
     durationInSeconds: Double
     message: String
     createdDateTime: OffsetDateTime
     lastActionDateTime: OffsetDateTime
     startTime: OffsetDateTime
     endTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Parameters:

jobId - ID of the job.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

createCascadeDeleteJob

public DynamicRequest createCascadeDeleteJob(String jobId,
 String farmerId,
 String oauthProviderId)

Create a cascade delete job for OAuth tokens.

Response Body Schema

 {
     farmerId: String
     resourceId: String
     resourceType: String
     id: String
     status: String
     durationInSeconds: Double
     message: String
     createdDateTime: OffsetDateTime
     lastActionDateTime: OffsetDateTime
     startTime: OffsetDateTime
     endTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Parameters:

jobId - Job ID supplied by end user.

farmerId - ID of the farmer.

oauthProviderId - ID of the OAuthProvider.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

listNext

public DynamicRequest listNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             authProviderId: String
             isValid: Boolean
             eTag: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

nextLink - The nextLink parameter.

Returns:

a DynamicRequest where customizations can be made before sent to the service.

invoke

public DynamicRequest invoke()

Create an empty DynamicRequest with the serializer and pipeline initialized for this client.

Returns:

a DynamicRequest where customizations can be made before sent to the service.