public final class SeasonalFieldsBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
com.azure.core.experimental.http.DynamicRequest |
createCascadeDeleteJob(String jobId,
String farmerId,
String seasonalFieldId)
Create a cascade delete job for specified seasonal field.
|
com.azure.core.experimental.http.DynamicRequest |
createOrUpdate(String farmerId,
String seasonalFieldId)
Creates or Updates a seasonal field resource under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
delete(String farmerId,
String seasonalFieldId)
Deletes a specified seasonal-field resource under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
get(String farmerId,
String seasonalFieldId)
Gets a specified seasonal field resource under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
getCascadeDeleteJobDetails(String jobId)
Get cascade delete job for specified seasonal field.
|
com.azure.core.experimental.http.DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
com.azure.core.experimental.http.DynamicRequest |
list()
Returns a paginated list of seasonal field resources across all farmers.
|
com.azure.core.experimental.http.DynamicRequest |
listByFarmerId(String farmerId)
Returns a paginated list of seasonal field resources under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
listByFarmerIdNext(String nextLink)
Get the next page of items.
|
com.azure.core.experimental.http.DynamicRequest |
listNext(String nextLink)
Get the next page of items.
|
public com.azure.core.experimental.http.DynamicRequest listByFarmerId(String farmerId)
Optional Query Parameters
Name | Type | Description |
---|---|---|
farmIds | List<String> | Farm Ids of the resource. |
fieldIds | List<String> | Field Ids of the resource. |
seasonIds | List<String> | Season Ids of the resource. |
cropVarietyIds | List<String> | CropVarietyIds of the resource. |
cropIds | List<String> | Ids of the crop it belongs to. |
minAvgYieldValue | Double | Minimum average yield value of the seasonal field(inclusive). |
maxAvgYieldValue | Double | Maximum average yield value of the seasonal field(inclusive). |
avgYieldUnit | String | Unit of the average yield value attribute. |
minAvgSeedPopulationValue | Double | Minimum average seed population value of the seasonal field(inclusive). |
maxAvgSeedPopulationValue | Double | Maximum average seed population value of the seasonal field(inclusive). |
avgSeedPopulationUnit | String | Unit of average seed population value attribute. |
minPlantingDateTime | OffsetDateTime | Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. |
maxPlantingDateTime | OffsetDateTime | Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. |
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
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
farmerId
- ID of the associated farmer.public com.azure.core.experimental.http.DynamicRequest list()
Optional Query Parameters
Name | Type | Description |
---|---|---|
farmIds | List<String> | Farm Ids of the resource. |
fieldIds | List<String> | Field Ids of the resource. |
seasonIds | List<String> | Season Ids of the resource. |
cropVarietyIds | List<String> | CropVarietyIds of the resource. |
cropIds | List<String> | Ids of the crop it belongs to. |
minAvgYieldValue | Double | Minimum average yield value of the seasonal field(inclusive). |
maxAvgYieldValue | Double | Maximum average yield value of the seasonal field(inclusive). |
avgYieldUnit | String | Unit of the average yield value attribute. |
minAvgSeedPopulationValue | Double | Minimum average seed population value of the seasonal field(inclusive). |
maxAvgSeedPopulationValue | Double | Maximum average seed population value of the seasonal field(inclusive). |
avgSeedPopulationUnit | String | Unit of average seed population value attribute. |
minPlantingDateTime | OffsetDateTime | Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. |
maxPlantingDateTime | OffsetDateTime | Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. |
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
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
public com.azure.core.experimental.http.DynamicRequest get(String farmerId, String seasonalFieldId)
Response Body Schema
{
farmerId: String
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
farmerId
- ID of the associated farmer.seasonalFieldId
- ID of the seasonal field.public com.azure.core.experimental.http.DynamicRequest createOrUpdate(String farmerId, String seasonalFieldId)
Request Body Schema
{
farmerId: String
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
Response Body Schema
(recursive schema, see above)
farmerId
- ID of the associated farmer resource.seasonalFieldId
- ID of the seasonal field resource.public com.azure.core.experimental.http.DynamicRequest delete(String farmerId, String seasonalFieldId)
farmerId
- ID of the farmer.seasonalFieldId
- ID of the seasonal field.public com.azure.core.experimental.http.DynamicRequest getCascadeDeleteJobDetails(String jobId)
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
}
}
jobId
- ID of the job.public com.azure.core.experimental.http.DynamicRequest createCascadeDeleteJob(String jobId, String farmerId, String seasonalFieldId)
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
}
}
jobId
- Job ID supplied by end user.farmerId
- ID of the associated farmer.seasonalFieldId
- ID of the seasonalField to be deleted.public com.azure.core.experimental.http.DynamicRequest listByFarmerIdNext(String nextLink)
Response Body Schema
{
value: [
{
farmerId: String
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest listNext(String nextLink)
Response Body Schema
{
value: [
{
farmerId: String
primaryBoundaryId: String
boundaryIds: [
String
]
farmId: String
fieldId: String
seasonId: String
cropVarietyIds: [
String
]
cropId: String
avgYieldValue: Double
avgYieldUnit: String
avgSeedPopulationValue: Double
avgSeedPopulationUnit: String
plantingDateTime: OffsetDateTime
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
]
skipToken: String
nextLink: String
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest invoke()
Copyright © 2021 Microsoft Corporation. All rights reserved.