## On this page

  

 

 # asset\_preparation::v3::environment::EnvironmentPreparation Class Reference

 Last update: 16.07.2025 

Environment Preparation Service. [More...](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#details)

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

[CreateEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_create_environment_response.xhtml) [CreateEnvironment](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a0d406f266c22026fdf32f7b538932139) ([CreateEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_create_environment_request.xhtml)) [GetEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_get_environment_response.xhtml) [GetEnvironment](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a8927f847fb4eb63aad999f4d820e5fb0) ([GetEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_environment_request.xhtml)) [ListEnvironmentsResponse](structasset__preparation_1_1v3_1_1environment_1_1_list_environments_response.xhtml) [ListEnvironments](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a9aca0fc766545f2b47ec6cb3a45167be) (google::protobuf::Empty) [UpdateEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_update_environment_response.xhtml) [UpdateEnvironment](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a682353cadc2925ab72b1a39783a30d2a) ([UpdateEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_update_environment_request.xhtml)) [DeleteEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_delete_environment_response.xhtml) [DeleteEnvironment](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a3823434d2dc98d77e21a0dcc96a60876) ([DeleteEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_delete_environment_request.xhtml)) stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml) [GetTrackChunks](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a1cf0487e04a7354e3a65b29168b8e399) ([GetTrackChunksRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_track_chunks_request.xhtml)) [GetTrackFileResponse](structasset__preparation_1_1v3_1_1environment_1_1_get_track_file_response.xhtml) [GetTrackFile](classasset__preparation_1_1v3_1_1environment_1_1_environment_preparation.xhtml#a8d9e513cfb5c99fc25c7e17d7c27048b) ([GetTrackFileRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_track_file_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Environment Preparation Service.

This service is used to create, edit and manage environments.



## Member Function Documentation

<a id="a0d406f266c22026fdf32f7b538932139"></a>## [◆ ](#a0d406f266c22026fdf32f7b538932139)CreateEnvironment()

 [CreateEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_create_environment_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::CreateEnvironment  ( [CreateEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_create_environment_request.xhtml)  ) 

Creates a new environment with an optional given name.

NoteNames must be unique amongst sibling environments.Returns the identifier of the created environment.





<a id="a8927f847fb4eb63aad999f4d820e5fb0"></a>## [◆ ](#a8927f847fb4eb63aad999f4d820e5fb0)GetEnvironment()

 [GetEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_get_environment_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::GetEnvironment  ( [GetEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_environment_request.xhtml)  ) 

Gets an environment properties, given its identifier.

Returns the environment properties.





<a id="a9aca0fc766545f2b47ec6cb3a45167be"></a>## [◆ ](#a9aca0fc766545f2b47ec6cb3a45167be)ListEnvironments()

 [ListEnvironmentsResponse](structasset__preparation_1_1v3_1_1environment_1_1_list_environments_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::ListEnvironments  ( google::protobuf::Empty  ) 

Lists all the created environments.

Returns the identifiers and names of the environments.





<a id="a682353cadc2925ab72b1a39783a30d2a"></a>## [◆ ](#a682353cadc2925ab72b1a39783a30d2a)UpdateEnvironment()

 [UpdateEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_update_environment_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::UpdateEnvironment  ( [UpdateEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_update_environment_request.xhtml)  ) 

Edits the properties of an environment, given its identifier.

NoteNames must be unique amongst sibling environments. 



<a id="a3823434d2dc98d77e21a0dcc96a60876"></a>## [◆ ](#a3823434d2dc98d77e21a0dcc96a60876)DeleteEnvironment()

 [DeleteEnvironmentResponse](structasset__preparation_1_1v3_1_1environment_1_1_delete_environment_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::DeleteEnvironment  ( [DeleteEnvironmentRequest](structasset__preparation_1_1v3_1_1environment_1_1_delete_environment_request.xhtml)  ) 

Deletes an environment, given its identifier.





<a id="a1cf0487e04a7354e3a65b29168b8e399"></a>## [◆ ](#a1cf0487e04a7354e3a65b29168b8e399)GetTrackChunks()

 stream [common::Chunk](structasset__preparation_1_1v3_1_1common_1_1_chunk.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::GetTrackChunks  ( [GetTrackChunksRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_track_chunks_request.xhtml)  ) 

Packages the environment as a track and exports it as a byte stream.

NoteThe 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. 



<a id="a8d9e513cfb5c99fc25c7e17d7c27048b"></a>## [◆ ](#a8d9e513cfb5c99fc25c7e17d7c27048b)GetTrackFile()

 [GetTrackFileResponse](structasset__preparation_1_1v3_1_1environment_1_1_get_track_file_response.xhtml) asset\_preparation::v3::environment::EnvironmentPreparation::GetTrackFile  ( [GetTrackFileRequest](structasset__preparation_1_1v3_1_1environment_1_1_get_track_file_request.xhtml)  ) 

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