com.azure.verticals.agrifood.farming.SeasonalFieldsClient

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

Create a cascade delete job for specified seasonal field.

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

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

Creates or Updates a seasonal field resource under a particular party.

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

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

Deletes a specified seasonal-field 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 seasonal field.

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

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

Gets a specified seasonal field 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 seasonal field 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 seasonal field resources under a particular party.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

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 seasonal field resources under a particular party.

Query Parameters

Query Parameters
Name	Type	Required	Description
farmIds	List<String>	No	Farm Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
fieldIds	List<String>	No	Field Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
seasonIds	List<String>	No	Season Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
cropProductIds	List<String>	No	CropProductIds of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
cropIds	List<String>	No	Ids of the crop it belongs to. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
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)
     farmId: String (Optional)
     fieldId: String (Optional)
     seasonId: String (Optional)
     cropProductIds (Optional): [
         String (Optional)
     ]
     cropId: 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.

getWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String partyId, String seasonalFieldId, com.azure.core.http.rest.RequestOptions requestOptions)
Gets a specified seasonal field resource under a particular party.
Response Body Schema
```
 {
     partyId: String (Optional)
     farmId: String (Optional)
     fieldId: String (Optional)
     seasonId: String (Optional)
     cropProductIds (Optional): [
         String (Optional)
     ]
     cropId: 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.

seasonalFieldId - Id of the seasonal field.

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

Returns:

a specified seasonal field 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.

createOrUpdateWithResponse

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

Creates or Updates a seasonal field resource under a particular party.

Request Body Schema


 {
     partyId: String (Optional)
     farmId: String (Optional)
     fieldId: String (Optional)
     seasonId: String (Optional)
     cropProductIds (Optional): [
         String (Optional)
     ]
     cropId: 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)
     }
 }

Response Body Schema


 {
     partyId: String (Optional)
     farmId: String (Optional)
     fieldId: String (Optional)
     seasonId: String (Optional)
     cropProductIds (Optional): [
         String (Optional)
     ]
     cropId: 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 resource.; seasonalFieldId - Id of the seasonal field resource.; seasonalField - Seasonal field resource payload to create or update.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: schema of seasonal field 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.

deleteWithResponse

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

Deletes a specified seasonal-field resource under a particular party.

Parameters:

partyId - Id of the party.

seasonalFieldId - Id of the seasonal field.

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.

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 seasonal field resources across all parties.

Query Parameters

Query Parameters
Name	Type	Required	Description
farmIds	List<String>	No	Farm Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
fieldIds	List<String>	No	Field Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
seasonIds	List<String>	No	Season Ids of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
cropProductIds	List<String>	No	CropProductIds of the resource. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
cropIds	List<String>	No	Ids of the crop it belongs to. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.
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)
     farmId: String (Optional)
     fieldId: String (Optional)
     seasonId: String (Optional)
     cropProductIds (Optional): [
         String (Optional)
     ]
     cropId: 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.

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 seasonal field.
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 seasonal field 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 seasonalFieldId, com.azure.core.http.rest.RequestOptions requestOptions)
Create a cascade delete job for specified seasonal field.
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.

seasonalFieldId - ID of the seasonalField 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.

Class SeasonalFieldsClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

listByPartyId

getWithResponse

createOrUpdateWithResponse

deleteWithResponse

list

getCascadeDeleteJobDetailsWithResponse

beginCreateCascadeDeleteJob