Package com.azure.verticals.agrifood.farming

Class BoundariesBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.BoundariesBaseClient

public final class BoundariesBaseClient
extends Object

Initializes a new instance of the BoundariesBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createCascadeDeleteJob(String jobId, String farmerId, String boundaryId)	Create a cascade delete job for specified boundary.
DynamicRequest	createOrUpdate(String farmerId, String boundaryId)	Creates or updates a boundary resource.
DynamicRequest	delete(String farmerId, String boundaryId)	Deletes a specified boundary resource under a particular farmer.
DynamicRequest	get(String farmerId, String boundaryId)	Gets a specified boundary resource under a particular farmer.
DynamicRequest	getCascadeDeleteJobDetails(String jobId)	Get cascade delete job for specified boundary.
DynamicRequest	getOverlap(String farmerId, String boundaryId, String otherFarmerId, String otherBoundaryId)	Returns overlapping acreage between two boundary Ids.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list()	Returns a paginated list of boundary resources across all farmers.
DynamicRequest	listByFarmerId(String farmerId)	Returns a paginated list of boundary resources under a particular farmer.
DynamicRequest	listByFarmerIdNext(String nextLink)	Get the next page of items.
DynamicRequest	listNext(String nextLink)	Get the next page of items.
DynamicRequest	search()	Search for boundaries across all farmers by fields and intersecting geometry.
DynamicRequest	searchByFarmerId(String farmerId)	Search for boundaries by fields and intersecting geometry.
DynamicRequest	searchByFarmerIdNext(String nextLink)	Get the next page of items.
DynamicRequest	searchNext(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

listByFarmerId

public DynamicRequest listByFarmerId(String farmerId)

Returns a paginated list of boundary resources under a particular farmer.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
isPrimary	Boolean	Is the boundary primary.
parentType	String	Type of the parent it belongs to.
parentIds	List<String>	Parent Ids of the resource.
minAcreage	Double	Minimum acreage of the boundary (inclusive).
maxAcreage	Double	Maximum acreage of the boundary (inclusive).
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: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

farmerId - ID of the associated farmer.

Returns:

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

searchByFarmerId

public DynamicRequest searchByFarmerId(String farmerId)

Search for boundaries by fields and intersecting geometry.

Request Body Schema

 {
     ids: [
         String
     ]
     names: [
         String
     ]
     propertyFilters: [
         String
     ]
     statuses: [
         String
     ]
     minCreatedDateTime: OffsetDateTime
     maxCreatedDateTime: OffsetDateTime
     minLastModifiedDateTime: OffsetDateTime
     maxLastModifiedDateTime: OffsetDateTime
     maxPageSize: Integer
     skipToken: String
     isPrimary: Boolean
     parentType: String
     parentIds: [
         String
     ]
     minAcreage: Double
     maxAcreage: Double
     intersectsWithGeometry: {
     }
 }
 

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: (recursive schema, see geometry above)
             isPrimary: Boolean
             acreage: Double
             parentType: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

farmerId - ID of the farmer.

Returns:

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

list

public DynamicRequest list()

Returns a paginated list of boundary resources across all farmers.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
isPrimary	Boolean	Is the boundary primary.
parentType	String	Type of the parent it belongs to.
parentIds	List<String>	Parent Ids of the resource.
minAcreage	Double	Minimum acreage of the boundary (inclusive).
maxAcreage	Double	Maximum acreage of the boundary (inclusive).
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: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.

search

public DynamicRequest search()

Search for boundaries across all farmers by fields and intersecting geometry.

Request Body Schema

 {
     ids: [
         String
     ]
     names: [
         String
     ]
     propertyFilters: [
         String
     ]
     statuses: [
         String
     ]
     minCreatedDateTime: OffsetDateTime
     maxCreatedDateTime: OffsetDateTime
     minLastModifiedDateTime: OffsetDateTime
     maxLastModifiedDateTime: OffsetDateTime
     maxPageSize: Integer
     skipToken: String
     isPrimary: Boolean
     parentType: String
     parentIds: [
         String
     ]
     minAcreage: Double
     maxAcreage: Double
     intersectsWithGeometry: {
     }
 }
 

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: (recursive schema, see geometry above)
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.

getCascadeDeleteJobDetails

public DynamicRequest getCascadeDeleteJobDetails(String jobId)

Get cascade delete job for specified boundary.

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 boundaryId)

Create a cascade delete job for specified boundary.

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 associated farmer.

boundaryId - ID of the boundary to be deleted.

Returns:

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

get

public DynamicRequest get(String farmerId,
 String boundaryId)

Gets a specified boundary resource under a particular farmer.

Response Body Schema

 {
     farmerId: String
     parentId: String
     geometry: {
     }
     isPrimary: Boolean
     acreage: Double
     parentType: String
     id: String
     eTag: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     properties: {
         String: Object
     }
 }
 

Parameters:

farmerId - ID of the associated farmer.

boundaryId - ID of the boundary.

Returns:

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

createOrUpdate

public DynamicRequest createOrUpdate(String farmerId,
 String boundaryId)

Creates or updates a boundary resource.

Request Body Schema

 {
     farmerId: String
     parentId: String
     geometry: {
     }
     isPrimary: Boolean
     acreage: Double
     parentType: String
     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.

boundaryId - ID of the boundary resource.

Returns:

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

delete

public DynamicRequest delete(String farmerId,
 String boundaryId)

Deletes a specified boundary resource under a particular farmer.

Parameters:

farmerId - ID of the farmer.

boundaryId - ID of the boundary.

Returns:

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

getOverlap

public DynamicRequest getOverlap(String farmerId,
 String boundaryId,
 String otherFarmerId,
 String otherBoundaryId)

Returns overlapping acreage between two boundary Ids.

Response Body Schema

 {
     boundaryAcreage: Double
     otherBoundaryAcreage: Double
     intersectingAcreage: Double
 }
 

Parameters:

farmerId - ID of the farmer.

boundaryId - ID of the boundary.

otherFarmerId - FarmerId of the other field.

otherBoundaryId - ID of the other boundary.

Returns:

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

listByFarmerIdNext

public DynamicRequest listByFarmerIdNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.

searchByFarmerIdNext

public DynamicRequest searchByFarmerIdNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.

listNext

public DynamicRequest listNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.

searchNext

public DynamicRequest searchNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             parentId: String
             geometry: {
             }
             isPrimary: Boolean
             acreage: Double
             parentType: String
             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.