## On this page

  

 

 # asset\_preparation::v3::resource::ResourcePreparation Class Reference

 Last update: 16.07.2025 

Resource Preparation Service. [More...](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

[UploadResourceResponse](structasset__preparation_1_1v3_1_1resource_1_1_upload_resource_response.xhtml) [UploadResource](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#afb079f16c14c3ada6395aa15a8ffcb4f) (stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml)) stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml) [DownloadResourceAsChunks](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#a2fe59a9f4be67af90c1315d1a8ed3cf2) ([DownloadResourceAsChunksRequest](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_chunks_request.xhtml)) [DownloadResourceAsFileResponse](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_file_response.xhtml) [DownloadResourceAsFile](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#ad325e3300ef27b087e3b26f8a97d5dbc) ([DownloadResourceAsFileRequest](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_file_request.xhtml)) [ListResourcesResponse](structasset__preparation_1_1v3_1_1resource_1_1_list_resources_response.xhtml) [ListResources](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#af0736c4a8cb4cdc328d78951b44d76e0) ([ListResourcesRequest](structasset__preparation_1_1v3_1_1resource_1_1_list_resources_request.xhtml)) [DeleteResourceResponse](structasset__preparation_1_1v3_1_1resource_1_1_delete_resource_response.xhtml) [DeleteResource](classasset__preparation_1_1v3_1_1resource_1_1_resource_preparation.xhtml#ad95074413af82666a3ce394dd90d7384) ([DeleteResourceRequest](structasset__preparation_1_1v3_1_1resource_1_1_delete_resource_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Resource Preparation Service.

This service is used to manage resources.



## Member Function Documentation

<a id="afb079f16c14c3ada6395aa15a8ffcb4f"></a>## [◆ ](#afb079f16c14c3ada6395aa15a8ffcb4f)UploadResource()

 [UploadResourceResponse](structasset__preparation_1_1v3_1_1resource_1_1_upload_resource_response.xhtml) asset\_preparation::v3::resource::ResourcePreparation::UploadResource  ( stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml)  ) 

Uploads a new resource with a given stream of chunks containing the "AVX MIMEType" metadata.

NoteA resource name can be provided using the "AVX DataName" key in the metadata.Importing an irradiance map may take several minutes. The server response may be "freezing" during the import time.Returns the identity of the created resource.





<a id="a2fe59a9f4be67af90c1315d1a8ed3cf2"></a>## [◆ ](#a2fe59a9f4be67af90c1315d1a8ed3cf2)DownloadResourceAsChunks()

 stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml) asset\_preparation::v3::resource::ResourcePreparation::DownloadResourceAsChunks  ( [DownloadResourceAsChunksRequest](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_chunks_request.xhtml)  ) 

Downloads a resource binary content as a stream of chunks with a given identifier and type.

NoteThe first chunk of the stream provides the metadata "AVX MIMEType" and "AVX DataName". The last chunk of the stream provides the metadata "AVX Status Error" if an error occurred, "AVX Status Warning" or "AVX Status Info" if the export succeeded.Irradiance maps cannot be downloaded. 



<a id="ad325e3300ef27b087e3b26f8a97d5dbc"></a>## [◆ ](#ad325e3300ef27b087e3b26f8a97d5dbc)DownloadResourceAsFile()

 [DownloadResourceAsFileResponse](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_file_response.xhtml) asset\_preparation::v3::resource::ResourcePreparation::DownloadResourceAsFile  ( [DownloadResourceAsFileRequest](structasset__preparation_1_1v3_1_1resource_1_1_download_resource_as_file_request.xhtml)  ) 

Downloads a resource file with a given identifier, type and destination path.

NoteIrradiance maps cannot be downloaded. 



<a id="af0736c4a8cb4cdc328d78951b44d76e0"></a>## [◆ ](#af0736c4a8cb4cdc328d78951b44d76e0)ListResources()

 [ListResourcesResponse](structasset__preparation_1_1v3_1_1resource_1_1_list_resources_response.xhtml) asset\_preparation::v3::resource::ResourcePreparation::ListResources  ( [ListResourcesRequest](structasset__preparation_1_1v3_1_1resource_1_1_list_resources_request.xhtml)  ) 

Lists the identity of each resource of the given type.

NoteIf no type is provided, all the resources are listed. 



<a id="ad95074413af82666a3ce394dd90d7384"></a>## [◆ ](#ad95074413af82666a3ce394dd90d7384)DeleteResource()

 [DeleteResourceResponse](structasset__preparation_1_1v3_1_1resource_1_1_delete_resource_response.xhtml) asset\_preparation::v3::resource::ResourcePreparation::DeleteResource  ( [DeleteResourceRequest](structasset__preparation_1_1v3_1_1resource_1_1_delete_resource_request.xhtml)  ) 

Deletes a resource, given its identifier and type.

NoteIf no identifier and type are provided, all the resources are released.If only the type is provided, all the resources of the given type are released. 



---

The documentation for this class was generated from the following file:- resource.proto