com.azure.verticals.agrifood.farming.BoundariesClient

public final class BoundariesClient 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 boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)

Create a cascade delete job for specified boundary.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createOrUpdateWithResponse(String partyId, String boundaryId, com.azure.core.util.BinaryData boundary, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates a boundary resource.

com.azure.core.http.rest.Response<Void>

deleteWithResponse(String partyId, String boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified boundary resource under a particular party.

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 specified boundary.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getOverlapWithResponse(String partyId, String boundaryId, String otherPartyId, String otherBoundaryId, com.azure.core.http.rest.RequestOptions requestOptions)

Returns overlapping area between two boundary Ids.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getWithResponse(String partyId, String boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)

Gets a specified boundary resource under a particular party.

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

list(com.azure.core.http.rest.RequestOptions requestOptions)

Returns a paginated list of boundary resources across all parties.

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

listByPartyId(String partyId, com.azure.core.http.rest.RequestOptions requestOptions)

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

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

search(com.azure.core.util.BinaryData searchBoundaryQuery, com.azure.core.http.rest.RequestOptions requestOptions)

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

com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>

searchByPartyId(String partyId, com.azure.core.util.BinaryData searchBoundaryQuery, com.azure.core.http.rest.RequestOptions requestOptions)

Search for boundaries by fields and intersecting geometry.

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 paginated list of boundary resources across all parties.

Query Parameters

Query Parameters
Name	Type	Required	Description
parentType	String	No	Type of the parent it belongs to.
type	String	No	Type it belongs to.
parentIds	List<String>	No	Parent Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
minArea	Double	No	Minimum area of the boundary (inclusive).
maxArea	Double	No	Maximum acreage of the boundary (inclusive).
ids	List<String>	No	Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
names	List<String>	No	Names of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
propertyFilters	List<String>	No	Filters 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.
statuses	List<String>	No	Statuses of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
minCreatedDateTime	OffsetDateTime	No	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	No	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	No	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	No	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	No	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	No	Skip 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 (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (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 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.

search

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> search(com.azure.core.util.BinaryData searchBoundaryQuery, com.azure.core.http.rest.RequestOptions requestOptions)

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

Request Body Schema


 {
     ids (Optional): [
         String (Optional)
     ]
     names (Optional): [
         String (Optional)
     ]
     propertyFilters (Optional): [
         String (Optional)
     ]
     statuses (Optional): [
         String (Optional)
     ]
     minCreatedDateTime: OffsetDateTime (Optional)
     maxCreatedDateTime: OffsetDateTime (Optional)
     minLastModifiedDateTime: OffsetDateTime (Optional)
     maxLastModifiedDateTime: OffsetDateTime (Optional)
     maxPageSize: Integer (Optional)
     skipToken: String (Optional)
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     parentIds (Optional): [
         String (Optional)
     ]
     minArea: Double (Optional)
     maxArea: Double (Optional)
     intersectsWithGeometry (Optional): {
     }
 }

Response Body Schema


 {
     partyId: String (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: searchBoundaryQuery - Query filters.; 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.

beginCreateCascadeDeleteJob

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateCascadeDeleteJob(String jobId, String partyId, String boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)
Create a cascade delete job for specified boundary.
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 associated party.

boundaryId - ID of the boundary to be deleted.

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.
getCascadeDeleteJobDetailsWithResponse

public 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 specified boundary.
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:

cascade delete job for specified boundary 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.

listByPartyId

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listByPartyId(String partyId, com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters
Name	Type	Required	Description
parentType	String	No	Type of the parent it belongs to.
type	String	No	Type it belongs to.
parentIds	List<String>	No	Parent Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
minArea	Double	No	Minimum area of the boundary (inclusive).
maxArea	Double	No	Maximum acreage of the boundary (inclusive).
ids	List<String>	No	Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
names	List<String>	No	Names of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
propertyFilters	List<String>	No	Filters 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.
statuses	List<String>	No	Statuses of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
minCreatedDateTime	OffsetDateTime	No	Minimum creation date of resource (inclusive).
maxCreatedDateTime	OffsetDateTime	No	Maximum creation date of resource (inclusive).
minLastModifiedDateTime	OffsetDateTime	No	Minimum last modified date of resource (inclusive).
maxLastModifiedDateTime	OffsetDateTime	No	Maximum last modified date of resource (inclusive).
maxPageSize	Integer	No	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skipToken	String	No	Skip 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 (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: partyId - Id of the associated party.; 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.

searchByPartyId

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> searchByPartyId(String partyId, com.azure.core.util.BinaryData searchBoundaryQuery, com.azure.core.http.rest.RequestOptions requestOptions)

Search for boundaries by fields and intersecting geometry.

Request Body Schema


 {
     ids (Optional): [
         String (Optional)
     ]
     names (Optional): [
         String (Optional)
     ]
     propertyFilters (Optional): [
         String (Optional)
     ]
     statuses (Optional): [
         String (Optional)
     ]
     minCreatedDateTime: OffsetDateTime (Optional)
     maxCreatedDateTime: OffsetDateTime (Optional)
     minLastModifiedDateTime: OffsetDateTime (Optional)
     maxLastModifiedDateTime: OffsetDateTime (Optional)
     maxPageSize: Integer (Optional)
     skipToken: String (Optional)
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     parentIds (Optional): [
         String (Optional)
     ]
     minArea: Double (Optional)
     maxArea: Double (Optional)
     intersectsWithGeometry (Optional): {
     }
 }

Response Body Schema


 {
     partyId: String (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     type: String (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: partyId - Id of the party.; searchBoundaryQuery - Query filters.; 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.

createOrUpdateWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateWithResponse(String partyId, String boundaryId, com.azure.core.util.BinaryData boundary, com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates a boundary resource.

Request Body Schema


 {
     geometry (Optional): {
     }
     type: String (Optional)
     crs: String (Optional)
     centroid (Optional): (recursive schema, see centroid above)
     bbox (Optional): (recursive schema, see bbox above)
     partyId: String (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Response Body Schema


 {
     geometry (Optional): {
     }
     type: String (Optional)
     crs: String (Optional)
     centroid (Optional): (recursive schema, see centroid above)
     bbox (Optional): (recursive schema, see bbox above)
     partyId: String (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }

Parameters:: partyId - Id of the party resource.; boundaryId - Id of the boundary resource.; boundary - Boundary resource payload to create or update.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: schema of boundary resource 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.

getWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String partyId, String boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)
Gets a specified boundary resource under a particular party.
Response Body Schema
```
 {
     geometry (Optional): {
     }
     type: String (Optional)
     crs: String (Optional)
     centroid (Optional): (recursive schema, see centroid above)
     bbox (Optional): (recursive schema, see bbox above)
     partyId: String (Optional)
     parentId: String (Optional)
     area (Optional): {
         unit: String (Optional)
         value: Double (Optional)
     }
     parentType: String(Field/SeasonalField/Zone/Prescription/PlantTissueAnalysis/ApplicationData/PlantingData/TillageData/HarvestData) (Optional)
     id: String (Optional)
     eTag: String (Optional)
     status: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     modifiedDateTime: OffsetDateTime (Optional)
     source: String (Optional)
     name: String (Optional)
     description: String (Optional)
     createdBy: String (Optional)
     modifiedBy: String (Optional)
     properties (Optional): {
         String: Object (Optional)
     }
 }
 
```
Parameters:

partyId - Id of the associated party.

boundaryId - Id of the boundary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a specified boundary resource under a particular party 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.
deleteWithResponse

public com.azure.core.http.rest.Response<Void> deleteWithResponse(String partyId, String boundaryId, com.azure.core.http.rest.RequestOptions requestOptions)

Deletes a specified boundary resource under a particular party.

Parameters:

partyId - Id of the party.

boundaryId - Id of the boundary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the 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.
getOverlapWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getOverlapWithResponse(String partyId, String boundaryId, String otherPartyId, String otherBoundaryId, com.azure.core.http.rest.RequestOptions requestOptions)
Returns overlapping area between two boundary Ids.
Response Body Schema
```
 {
     boundaryArea: Double (Optional)
     otherBoundaryArea: Double (Optional)
     intersectingArea: Double (Optional)
 }
 
```
Parameters:

partyId - Id of the party.

boundaryId - Id of the boundary.

otherPartyId - PartyId of the other field.

otherBoundaryId - Id of the other boundary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

schema of boundary overlap response 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.

Class BoundariesClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

list

search

beginCreateCascadeDeleteJob

getCascadeDeleteJobDetailsWithResponse

listByPartyId

searchByPartyId

createOrUpdateWithResponse

getWithResponse

deleteWithResponse

getOverlapWithResponse