asset_preparation::v3::surface_source::SurfaceSourcePreparation Class Reference
Last update: 16.07.2025Surface Source Preparation Service. More...
Detailed Description
Surface Source Preparation Service.
This service is used to create, edit and manage surface sources.
Member Function Documentation
◆ CreateSurfaceSource()
| CreateSurfaceSourceResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::CreateSurfaceSource | ( | CreateSurfaceSourceRequest | ) |
Creates a new surface source with an optional name and properties.
- Note
- If unspecified, default values are used.
Returns the identifier of the created surface source.
◆ GetSurfaceSource()
| GetSurfaceSourceResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::GetSurfaceSource | ( | GetSurfaceSourceRequest | ) |
Gets the properties of a surface source, given its identifier.
Returns the surface source or display source properties.
◆ ListSurfaceSources()
| ListSurfaceSourcesResponse 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.
◆ UpdateSurfaceSource()
| UpdateSurfaceSourceResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::UpdateSurfaceSource | ( | UpdateSurfaceSourceRequest | ) |
Edits the properties of a surface source, given its identifier.
- Note
- Names must be unique amongst surface sources.
◆ DeleteSurfaceSource()
| DeleteSurfaceSourceResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::DeleteSurfaceSource | ( | DeleteSurfaceSourceRequest | ) |
Deletes a surface source, given its identifier.
◆ CreateSurfaceSourceState()
| CreateSurfaceSourceStateResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::CreateSurfaceSourceState | ( | CreateSurfaceSourceStateRequest | ) |
Creates a new surface source state with optional properties.
- Note
- Names 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.
◆ GetSurfaceSourceState()
| GetSurfaceSourceStateResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::GetSurfaceSourceState | ( | GetSurfaceSourceStateRequest | ) |
Gets the properties of a surface source state, given the parent surface source identifier and the state name.
Returns the surface source state properties.
◆ UpdateSurfaceSourceState()
| UpdateSurfaceSourceStateResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::UpdateSurfaceSourceState | ( | UpdateSurfaceSourceStateRequest | ) |
Edits the properties of a state, given the parent surface source identifier and the state name.
- Note
- Names must be unique amongst sibling surface source states.
- "Default" name is reserved.
◆ DeleteSurfaceSourceState()
| DeleteSurfaceSourceStateResponse asset_preparation::v3::surface_source::SurfaceSourcePreparation::DeleteSurfaceSourceState | ( | DeleteSurfaceSourceStateRequest | ) |
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
