asset_preparation::v3::environment::EnvironmentPreparation Class Reference
Last update: 16.07.2025Environment Preparation Service. More...
Detailed Description
Environment Preparation Service.
This service is used to create, edit and manage environments.
Member Function Documentation
◆ CreateEnvironment()
| CreateEnvironmentResponse asset_preparation::v3::environment::EnvironmentPreparation::CreateEnvironment | ( | CreateEnvironmentRequest | ) |
Creates a new environment with an optional given name.
- Note
- Names must be unique amongst sibling environments.
Returns the identifier of the created environment.
◆ GetEnvironment()
| GetEnvironmentResponse asset_preparation::v3::environment::EnvironmentPreparation::GetEnvironment | ( | GetEnvironmentRequest | ) |
Gets an environment properties, given its identifier.
Returns the environment properties.
◆ ListEnvironments()
| ListEnvironmentsResponse asset_preparation::v3::environment::EnvironmentPreparation::ListEnvironments | ( | google::protobuf::Empty | ) |
Lists all the created environments.
Returns the identifiers and names of the environments.
◆ UpdateEnvironment()
| UpdateEnvironmentResponse asset_preparation::v3::environment::EnvironmentPreparation::UpdateEnvironment | ( | UpdateEnvironmentRequest | ) |
Edits the properties of an environment, given its identifier.
- Note
- Names must be unique amongst sibling environments.
◆ DeleteEnvironment()
| DeleteEnvironmentResponse asset_preparation::v3::environment::EnvironmentPreparation::DeleteEnvironment | ( | DeleteEnvironmentRequest | ) |
Deletes an environment, given its identifier.
◆ GetTrackChunks()
| stream common::Chunk asset_preparation::v3::environment::EnvironmentPreparation::GetTrackChunks | ( | GetTrackChunksRequest | ) |
Packages the environment as a track and exports it as a byte stream.
- Note
- 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.
◆ GetTrackFile()
| GetTrackFileResponse asset_preparation::v3::environment::EnvironmentPreparation::GetTrackFile | ( | GetTrackFileRequest | ) |
Packages the environment as a track and exports it as a .track file.
The documentation for this class was generated from the following file:
- environment.proto
