    

 ## On this page

  

 

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

 Last update: 16.07.2025 

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

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

[CreateEnvironmentResponse](a00347.xhtml) [CreateEnvironment](a00339.xhtml#accd948b760b12a1a9cd25f9967de62a2) ([CreateEnvironmentRequest](a00343.xhtml)) [GetEnvironmentResponse](a00355.xhtml) [GetEnvironment](a00339.xhtml#a587f51f3d78e4e28ead23ae8e6d52a7f) ([GetEnvironmentRequest](a00351.xhtml)) [ListEnvironmentsResponse](a00359.xhtml) [ListEnvironments](a00339.xhtml#ab0f8a0c30a368cc18bc79d7aeca58c46) (google::protobuf::Empty) [UpdateEnvironmentResponse](a00367.xhtml) [UpdateEnvironment](a00339.xhtml#a21ed29a3893ee8905287bfdecde5a312) ([UpdateEnvironmentRequest](a00363.xhtml)) [DeleteEnvironmentResponse](a00375.xhtml) [DeleteEnvironment](a00339.xhtml#a8bfffc5b9ae80829dc7eec7fdf5cf74e) ([DeleteEnvironmentRequest](a00371.xhtml)) stream [common::Chunk](a00235.xhtml) [GetTrackChunks](a00339.xhtml#a93e6a0db453df6a07182ff1ab926d54e) ([GetTrackChunksRequest](a00379.xhtml)) [GetTrackFileResponse](a00387.xhtml) [GetTrackFile](a00339.xhtml#ace84032a99db45a6ea953e242d123a62) ([GetTrackFileRequest](a00383.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="accd948b760b12a1a9cd25f9967de62a2"></a>## [◆ ](#accd948b760b12a1a9cd25f9967de62a2)CreateEnvironment()

 [CreateEnvironmentResponse](a00347.xhtml) asset\_preparation::v2::environment::EnvironmentPreparation::CreateEnvironment  ( [CreateEnvironmentRequest](a00343.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="a8bfffc5b9ae80829dc7eec7fdf5cf74e"></a>## [◆ ](#a8bfffc5b9ae80829dc7eec7fdf5cf74e)DeleteEnvironment()

 [DeleteEnvironmentResponse](a00375.xhtml) asset\_preparation::v2::environment::EnvironmentPreparation::DeleteEnvironment  ( [DeleteEnvironmentRequest](a00371.xhtml)  ) 

Deletes an environment, given its identifier.





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

 [GetEnvironmentResponse](a00355.xhtml) asset\_preparation::v2::environment::EnvironmentPreparation::GetEnvironment  ( [GetEnvironmentRequest](a00351.xhtml)  ) 

Gets an environment properties, given its identifier.

Returns the environment properties.





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

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

 [GetTrackFileResponse](a00387.xhtml) asset\_preparation::v2::environment::EnvironmentPreparation::GetTrackFile  ( [GetTrackFileRequest](a00383.xhtml)  ) 

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





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

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

Lists all the created environments.

Returns the identifiers and names of the environments.





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

 [UpdateEnvironmentResponse](a00367.xhtml) asset\_preparation::v2::environment::EnvironmentPreparation::UpdateEnvironment  ( [UpdateEnvironmentRequest](a00363.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