## On this page

  

 

 # asset\_preparation::v3::surface\_source::SurfaceSourcePreparation Class Reference

 Last update: 16.07.2025 

Surface Source Preparation Service. [More...](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#details)

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

[CreateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_response.xhtml) [CreateSurfaceSource](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a6085b01df4fa33542538404c16cbbb66) ([CreateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_request.xhtml)) [GetSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_response.xhtml) [GetSurfaceSource](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a0cc6bc63fab7dbff83d40f5070d5d961) ([GetSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_request.xhtml)) [ListSurfaceSourcesResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_list_surface_sources_response.xhtml) [ListSurfaceSources](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#aa80f8c8a8300902bf675b05246cffa77) (google::protobuf::Empty) [UpdateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_response.xhtml) [UpdateSurfaceSource](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#ac19d15a7548991cf46d261739459ff7e) ([UpdateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_request.xhtml)) [DeleteSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_response.xhtml) [DeleteSurfaceSource](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a067595d997e6e554881e23f51f379fe4) ([DeleteSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_request.xhtml)) [CreateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_response.xhtml) [CreateSurfaceSourceState](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a65879c84ed86c25d9dd082d7c3139539) ([CreateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_request.xhtml)) [GetSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_response.xhtml) [GetSurfaceSourceState](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a0fca41895d052fcc2ece205268b10047) ([GetSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_request.xhtml)) [UpdateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_response.xhtml) [UpdateSurfaceSourceState](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a4a86cf9fc54965a2b806efb237de529d) ([UpdateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_request.xhtml)) [DeleteSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_response.xhtml) [DeleteSurfaceSourceState](classasset__preparation_1_1v3_1_1surface__source_1_1_surface_source_preparation.xhtml#a3442703910cbc81b5dee2cf92d826fd9) ([DeleteSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_request.xhtml)) <a id="details" name="details"></a>## Detailed Description

Surface Source Preparation Service.

This service is used to create, edit and manage surface sources.



## Member Function Documentation

<a id="a6085b01df4fa33542538404c16cbbb66"></a>## [◆ ](#a6085b01df4fa33542538404c16cbbb66)CreateSurfaceSource()

 [CreateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::CreateSurfaceSource  ( [CreateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_request.xhtml)  ) 

Creates a new surface source with an optional name and properties.

NoteIf unspecified, default values are used.Returns the identifier of the created surface source.





<a id="a0cc6bc63fab7dbff83d40f5070d5d961"></a>## [◆ ](#a0cc6bc63fab7dbff83d40f5070d5d961)GetSurfaceSource()

 [GetSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::GetSurfaceSource  ( [GetSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_request.xhtml)  ) 

Gets the properties of a surface source, given its identifier.

Returns the surface source or display source properties.





<a id="aa80f8c8a8300902bf675b05246cffa77"></a>## [◆ ](#aa80f8c8a8300902bf675b05246cffa77)ListSurfaceSources()

 [ListSurfaceSourcesResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_list_surface_sources_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::ListSurfaceSources  ( google::protobuf::Empty  ) 

Lists all the created surface sources.

Returns the identifiers and names of the surface sources.





<a id="ac19d15a7548991cf46d261739459ff7e"></a>## [◆ ](#ac19d15a7548991cf46d261739459ff7e)UpdateSurfaceSource()

 [UpdateSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::UpdateSurfaceSource  ( [UpdateSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_request.xhtml)  ) 

Edits the properties of a surface source, given its identifier.

NoteNames must be unique amongst surface sources. 



<a id="a067595d997e6e554881e23f51f379fe4"></a>## [◆ ](#a067595d997e6e554881e23f51f379fe4)DeleteSurfaceSource()

 [DeleteSurfaceSourceResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::DeleteSurfaceSource  ( [DeleteSurfaceSourceRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_request.xhtml)  ) 

Deletes a surface source, given its identifier.





<a id="a65879c84ed86c25d9dd082d7c3139539"></a>## [◆ ](#a65879c84ed86c25d9dd082d7c3139539)CreateSurfaceSourceState()

 [CreateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::CreateSurfaceSourceState  ( [CreateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_create_surface_source_state_request.xhtml)  ) 

Creates a new surface source state with optional properties.

NoteNames must be unique amongst sibling surface source states."Default" name is reserved.If some properties are not specified, default values are used.Returns the information about the created surface source state.





<a id="a0fca41895d052fcc2ece205268b10047"></a>## [◆ ](#a0fca41895d052fcc2ece205268b10047)GetSurfaceSourceState()

 [GetSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::GetSurfaceSourceState  ( [GetSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_get_surface_source_state_request.xhtml)  ) 

Gets the properties of a surface source state, given the parent surface source identifier and the state name.

Returns the surface source state properties.





<a id="a4a86cf9fc54965a2b806efb237de529d"></a>## [◆ ](#a4a86cf9fc54965a2b806efb237de529d)UpdateSurfaceSourceState()

 [UpdateSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::UpdateSurfaceSourceState  ( [UpdateSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_update_surface_source_state_request.xhtml)  ) 

Edits the properties of a state, given the parent surface source identifier and the state name.

NoteNames must be unique amongst sibling surface source states."Default" name is reserved. 



<a id="a3442703910cbc81b5dee2cf92d826fd9"></a>## [◆ ](#a3442703910cbc81b5dee2cf92d826fd9)DeleteSurfaceSourceState()

 [DeleteSurfaceSourceStateResponse](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_response.xhtml) asset\_preparation::v3::surface\_source::SurfaceSourcePreparation::DeleteSurfaceSourceState  ( [DeleteSurfaceSourceStateRequest](structasset__preparation_1_1v3_1_1surface__source_1_1_delete_surface_source_state_request.xhtml)  ) 

Deletes a surface source state, given the parent surface source identifier and the state name.





---

The documentation for this class was generated from the following file:- surface\_source.proto