Package com.azure.verticals.agrifood.farming

Class CropVarietiesBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.CropVarietiesBaseClient

public final class CropVarietiesBaseClient
extends Object

Initializes a new instance of the CropVarietiesBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createOrUpdate(String cropId, String cropVarietyId)	Creates or updates a crop variety resource.
DynamicRequest	delete(String cropId, String cropVarietyId)	Deletes a specified crop variety resource under a particular crop.
DynamicRequest	get(String cropId, String cropVarietyId)	Gets a specified crop variety resource under a particular crop.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	list()	Returns a paginated list of crop variety resources across all crops.
DynamicRequest	listByCropId(String cropId)	Returns a paginated list of crop variety resources under a particular crop.
DynamicRequest	listByCropIdNext(String nextLink)	Get the next page of items.
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

listByCropId

public DynamicRequest listByCropId(String cropId)

Returns a paginated list of crop variety resources under a particular crop.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
cropIds	List<String>	CropIds of the resource.
brands	List<String>	Brands of the resource.
products	List<String>	Products of the resource.
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: [
         {
             cropId: String
             brand: String
             product: String
             id: String
             eTag: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             properties: {
                 String: Object
             }
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

cropId - ID of the associated crop.

Returns:

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

list

public DynamicRequest list()

Returns a paginated list of crop variety resources across all crops.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
cropIds	List<String>	CropIds of the resource.
brands	List<String>	Brands of the resource.
products	List<String>	Products of the resource.
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: [
         {
             cropId: String
             brand: String
             product: 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.

get

public DynamicRequest get(String cropId,
 String cropVarietyId)

Gets a specified crop variety resource under a particular crop.

Response Body Schema

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

Parameters:

cropId - ID of the associated crop.

cropVarietyId - ID of the crop variety.

Returns:

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

createOrUpdate

public DynamicRequest createOrUpdate(String cropId,
 String cropVarietyId)

Creates or updates a crop variety resource.

Request Body Schema

 {
     cropId: String
     brand: String
     product: 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:

cropId - ID of the crop resource.

cropVarietyId - ID of the crop variety resource.

Returns:

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

delete

public DynamicRequest delete(String cropId,
 String cropVarietyId)

Deletes a specified crop variety resource under a particular crop.

Parameters:

cropId - ID of the crop.

cropVarietyId - ID of the crop variety.

Returns:

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

listByCropIdNext

public DynamicRequest listByCropIdNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             cropId: String
             brand: String
             product: 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: [
         {
             cropId: String
             brand: String
             product: 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.