    

 ## On this page

  

 

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

 Last update: 16.07.2025 

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

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

[CreateEnvironmentResponse](a00215.xhtml) [CreateEnvironment](a00207.xhtml#a0a06d1fb932b9868e5b5c35d322720c7) ([CreateEnvironmentRequest](a00211.xhtml)) [GetEnvironmentResponse](a00223.xhtml) [GetEnvironment](a00207.xhtml#af2154126c672b7e1ba2509fa4864fb31) ([GetEnvironmentRequest](a00219.xhtml)) [ListEnvironmentsResponse](a00227.xhtml) [ListEnvironments](a00207.xhtml#a5a6d37155b9d55c1e6863cd0ca560283) (google::protobuf::Empty) [UpdateEnvironmentResponse](a00235.xhtml) [UpdateEnvironment](a00207.xhtml#a6e3788ef73ba2d82d2573aee99de3c4c) ([UpdateEnvironmentRequest](a00231.xhtml)) [DeleteEnvironmentResponse](a00243.xhtml) [DeleteEnvironment](a00207.xhtml#a97e067fe5608ffa0452cfe8744b4c254) ([DeleteEnvironmentRequest](a00239.xhtml)) stream [common::Chunk](a00103.xhtml) [GetTrackChunks](a00207.xhtml#ac017a05da05dabbf4ea54b9e8d38dd42) ([GetTrackChunksRequest](a00247.xhtml)) [GetTrackFileResponse](a00255.xhtml) [GetTrackFile](a00207.xhtml#aca7fc2e2f8e91bc76aa8806bb1d1bb1d) ([GetTrackFileRequest](a00251.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="a0a06d1fb932b9868e5b5c35d322720c7"></a>## [◆ ](#a0a06d1fb932b9868e5b5c35d322720c7)CreateEnvironment()

 [CreateEnvironmentResponse](a00215.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::CreateEnvironment  ( [CreateEnvironmentRequest](a00211.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="a97e067fe5608ffa0452cfe8744b4c254"></a>## [◆ ](#a97e067fe5608ffa0452cfe8744b4c254)DeleteEnvironment()

 [DeleteEnvironmentResponse](a00243.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::DeleteEnvironment  ( [DeleteEnvironmentRequest](a00239.xhtml)  ) 

Deletes an environment, given its identifier.





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

 [GetEnvironmentResponse](a00223.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::GetEnvironment  ( [GetEnvironmentRequest](a00219.xhtml)  ) 

Gets an environment properties, given its identifier.

Returns the environment properties.





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

 stream [common::Chunk](a00103.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::GetTrackChunks  ( [GetTrackChunksRequest](a00247.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="aca7fc2e2f8e91bc76aa8806bb1d1bb1d"></a>## [◆ ](#aca7fc2e2f8e91bc76aa8806bb1d1bb1d)GetTrackFile()

 [GetTrackFileResponse](a00255.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::GetTrackFile  ( [GetTrackFileRequest](a00251.xhtml)  ) 

Packages the environment as a track and exports it as a .track file.





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

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

Lists all the created environments.

Returns the identifiers and names of the environments.





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

 [UpdateEnvironmentResponse](a00235.xhtml) asset\_preparation::v1::environment::EnvironmentPreparation::UpdateEnvironment  ( [UpdateEnvironmentRequest](a00231.xhtml)  ) 

Edits the properties of an environment, given its identifier.

NoteNames must be unique amongst sibling environments. 



---

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