public final class FarmersBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
com.azure.core.experimental.http.DynamicRequest |
createCascadeDeleteJob(String jobId,
String farmerId)
Create a cascade delete job for specified farmer.
|
com.azure.core.experimental.http.DynamicRequest |
createOrUpdate(String farmerId)
Creates or updates a farmer resource.
|
com.azure.core.experimental.http.DynamicRequest |
delete(String farmerId)
Deletes a specified farmer resource.
|
com.azure.core.experimental.http.DynamicRequest |
get(String farmerId)
Gets a specified farmer resource.
|
com.azure.core.experimental.http.DynamicRequest |
getCascadeDeleteJobDetails(String jobId)
Get a cascade delete job for specified farmer.
|
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 farmer resources.
|
com.azure.core.experimental.http.DynamicRequest |
listNext(String nextLink)
Get the next page of items.
|
public com.azure.core.experimental.http.DynamicRequest list()
Optional Query Parameters
Name | Type | Description |
---|---|---|
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: [
{
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)
Response Body Schema
{
id: String
eTag: String
status: String
createdDateTime: OffsetDateTime
modifiedDateTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
farmerId
- ID of the associated farmer.public com.azure.core.experimental.http.DynamicRequest createOrUpdate(String farmerId)
Request Body Schema
{
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.public com.azure.core.experimental.http.DynamicRequest delete(String farmerId)
farmerId
- ID of farmer to be deleted.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)
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 farmer to be deleted.public com.azure.core.experimental.http.DynamicRequest listNext(String nextLink)
Response Body Schema
{
value: [
{
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.