Package com.azure.verticals.agrifood.farming

Class AttachmentsBaseClient

java.lang.Object

com.azure.verticals.agrifood.farming.AttachmentsBaseClient

public final class AttachmentsBaseClient
extends Object

Initializes a new instance of the AttachmentsBaseClient type.

Method Summary

Modifier and Type	Method	Description
DynamicRequest	createOrUpdate(String farmerId, String attachmentId)	Creates or updates an attachment resource under a particular farmer.
DynamicRequest	delete(String farmerId, String attachmentId)	Deletes a specified attachment resource under a particular farmer.
DynamicRequest	download(String farmerId, String attachmentId)	Downloads and returns attachment as response for the given input filePath.
DynamicRequest	get(String farmerId, String attachmentId)	Gets a specified attachment resource under a particular farmer.
DynamicRequest	invoke()	Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
DynamicRequest	listByFarmerId(String farmerId)	Returns a paginated list of attachment resources under a particular farmer.
DynamicRequest	listByFarmerIdNext(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

listByFarmerId

public DynamicRequest listByFarmerId(String farmerId)

Returns a paginated list of attachment resources under a particular farmer.

Optional Query Parameters

Optional Query Parameters

Name	Type	Description
resourceIds	List<String>	Resource Ids of the resource.
resourceTypes	List<String>	Resource Types 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: [
         {
             farmerId: String
             resourceId: String
             resourceType: String
             originalFileName: String
             id: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             eTag: String
         }
     ]
     skipToken: String
     nextLink: String
 }
 

Parameters:

farmerId - ID of the associated farmer.

Returns:

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

get

public DynamicRequest get(String farmerId,
 String attachmentId)

Gets a specified attachment resource under a particular farmer.

Response Body Schema

 {
     farmerId: String
     resourceId: String
     resourceType: String
     originalFileName: String
     id: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     eTag: String
 }
 

Parameters:

farmerId - ID of the associated farmer.

attachmentId - ID of the attachment.

Returns:

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

createOrUpdate

public DynamicRequest createOrUpdate(String farmerId,
 String attachmentId)

Creates or updates an attachment resource under a particular farmer.

Optional Header Parameters

Optional Header Parameters

Name	Type	Description
contentLength	Long	The contentLength parameter

Request Body Schema

 Flux<ByteBuffer>
 

Response Body Schema

 {
     farmerId: String
     resourceId: String
     resourceType: String
     originalFileName: String
     id: String
     status: String
     createdDateTime: OffsetDateTime
     modifiedDateTime: OffsetDateTime
     name: String
     description: String
     eTag: String
 }
 

Parameters:

farmerId - ID of the associated farmer resource.

attachmentId - ID of the attachment resource.

Returns:

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

delete

public DynamicRequest delete(String farmerId,
 String attachmentId)

Deletes a specified attachment resource under a particular farmer.

Parameters:

farmerId - ID of the farmer.

attachmentId - ID of the attachment.

Returns:

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

download

public DynamicRequest download(String farmerId,
 String attachmentId)

Downloads and returns attachment as response for the given input filePath.

Parameters:

farmerId - ID of the associated farmer.

attachmentId - ID of attachment to be downloaded.

Returns:

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

listByFarmerIdNext

public DynamicRequest listByFarmerIdNext(String nextLink)

Get the next page of items.

Response Body Schema

 {
     value: [
         {
             farmerId: String
             resourceId: String
             resourceType: String
             originalFileName: String
             id: String
             status: String
             createdDateTime: OffsetDateTime
             modifiedDateTime: OffsetDateTime
             name: String
             description: String
             eTag: String
         }
     ]
     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.