public final class BoundariesBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
com.azure.core.experimental.http.DynamicRequest |
createCascadeDeleteJob(String jobId,
String farmerId,
String boundaryId)
Create a cascade delete job for specified boundary.
|
com.azure.core.experimental.http.DynamicRequest |
createOrUpdate(String farmerId,
String boundaryId)
Creates or updates a boundary resource.
|
com.azure.core.experimental.http.DynamicRequest |
delete(String farmerId,
String boundaryId)
Deletes a specified boundary resource under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
get(String farmerId,
String boundaryId)
Gets a specified boundary resource under a particular farmer.
|
com.azure.core.experimental.http.DynamicRequest |
getCascadeDeleteJobDetails(String jobId)
Get cascade delete job for specified boundary.
|
com.azure.core.experimental.http.DynamicRequest |
getOverlap(String farmerId,
String boundaryId,
String otherFarmerId,
String otherBoundaryId)
Returns overlapping acreage between two boundary Ids.
|
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 boundary resources across all farmers.
|
com.azure.core.experimental.http.DynamicRequest |
listByFarmerId(String farmerId)
Returns a paginated list of boundary 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.
|
com.azure.core.experimental.http.DynamicRequest |
search()
Search for boundaries across all farmers by fields and intersecting geometry.
|
com.azure.core.experimental.http.DynamicRequest |
searchByFarmerId(String farmerId)
Search for boundaries by fields and intersecting geometry.
|
com.azure.core.experimental.http.DynamicRequest |
searchByFarmerIdNext(String nextLink)
Get the next page of items.
|
com.azure.core.experimental.http.DynamicRequest |
searchNext(String nextLink)
Get the next page of items.
|
public com.azure.core.experimental.http.DynamicRequest listByFarmerId(String farmerId)
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
}
farmerId
- ID of the associated farmer.public com.azure.core.experimental.http.DynamicRequest searchByFarmerId(String farmerId)
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
}
farmerId
- ID of the farmer.public com.azure.core.experimental.http.DynamicRequest list()
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
}
public com.azure.core.experimental.http.DynamicRequest search()
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
}
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 boundaryId)
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.boundaryId
- ID of the boundary to be deleted.public com.azure.core.experimental.http.DynamicRequest get(String farmerId, String boundaryId)
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
}
}
farmerId
- ID of the associated farmer.boundaryId
- ID of the boundary.public com.azure.core.experimental.http.DynamicRequest createOrUpdate(String farmerId, String boundaryId)
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)
farmerId
- ID of the farmer resource.boundaryId
- ID of the boundary resource.public com.azure.core.experimental.http.DynamicRequest delete(String farmerId, String boundaryId)
farmerId
- ID of the farmer.boundaryId
- ID of the boundary.public com.azure.core.experimental.http.DynamicRequest getOverlap(String farmerId, String boundaryId, String otherFarmerId, String otherBoundaryId)
Response Body Schema
{
boundaryAcreage: Double
otherBoundaryAcreage: Double
intersectingAcreage: Double
}
farmerId
- ID of the farmer.boundaryId
- ID of the boundary.otherFarmerId
- FarmerId of the other field.otherBoundaryId
- ID of the other boundary.public com.azure.core.experimental.http.DynamicRequest listByFarmerIdNext(String nextLink)
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
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest searchByFarmerIdNext(String nextLink)
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
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest listNext(String nextLink)
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
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest searchNext(String nextLink)
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
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest invoke()
Copyright © 2021 Microsoft Corporation. All rights reserved.