Package com.azure.verticals.agrifood.farming

Class FarmersBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.FarmersBaseClient

public final class FarmersBaseClient
extends Object

Initializes a new instance of the FarmersBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createCascadeDeleteJob(String jobId, String farmerId)	Create a cascade delete job for specified farmer.
DynamicRequest	createOrUpdate(String farmerId)	Creates or updates a farmer resource.
DynamicRequest	delete(String farmerId)	Deletes a specified farmer resource.
DynamicRequest	get(String farmerId)	Gets a specified farmer resource.
DynamicRequest	getCascadeDeleteJobDetails(String jobId)	Get a cascade delete job for specified farmer.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list()	Returns a paginated list of farmer resources.
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 paginated list of farmer resources.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
ids	List<String>	Ids of the resource.
names	List<String>	Names of the resource.
propertyFilters	List<String>	Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".
statuses	List<String>	Statuses of the resource.
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: [
         {
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Returns:

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

get

public DynamicRequest get(String farmerId)

Gets a specified farmer resource.

Response Body Schema

 {
     id: String
     eTag: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Parameters:

farmerId - ID of the associated farmer.

Returns:

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

createOrUpdate

public DynamicRequest createOrUpdate(String farmerId)

Creates or updates a farmer resource.

Request Body Schema

 {
     id: String
     eTag: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Response Body Schema

 (recursive schema, see above)
 

Parameters:

farmerId - ID of the farmer resource.

Returns:

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

delete

public DynamicRequest delete(String farmerId)

Deletes a specified farmer resource.

Parameters:

farmerId - ID of farmer to be deleted.

Returns:

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

getCascadeDeleteJobDetails

public DynamicRequest getCascadeDeleteJobDetails(String jobId)

Get a cascade delete job for specified farmer.

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)

Create a cascade delete job for specified farmer.

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 to be deleted.

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: [
         {
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     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.