asset_preparation::v3::resource::ResourcePreparation Class Reference
Last update: 16.07.2025Resource Preparation Service. More...
Detailed Description
Resource Preparation Service.
This service is used to manage resources.
Member Function Documentation
◆ UploadResource()
| UploadResourceResponse asset_preparation::v3::resource::ResourcePreparation::UploadResource | ( | stream common::Chunk | ) |
Uploads a new resource with a given stream of chunks containing the "AVX MIMEType" metadata.
- Note
- A 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.
◆ DownloadResourceAsChunks()
| stream common::Chunk asset_preparation::v3::resource::ResourcePreparation::DownloadResourceAsChunks | ( | DownloadResourceAsChunksRequest | ) |
Downloads a resource binary content as a stream of chunks with a given identifier and type.
- Note
- The 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.
◆ DownloadResourceAsFile()
| DownloadResourceAsFileResponse asset_preparation::v3::resource::ResourcePreparation::DownloadResourceAsFile | ( | DownloadResourceAsFileRequest | ) |
Downloads a resource file with a given identifier, type and destination path.
- Note
- Irradiance maps cannot be downloaded.
◆ ListResources()
| ListResourcesResponse asset_preparation::v3::resource::ResourcePreparation::ListResources | ( | ListResourcesRequest | ) |
Lists the identity of each resource of the given type.
- Note
- If no type is provided, all the resources are listed.
◆ DeleteResource()
| DeleteResourceResponse asset_preparation::v3::resource::ResourcePreparation::DeleteResource | ( | DeleteResourceRequest | ) |
Deletes a resource, given its identifier and type.
- Note
- If 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
