Skip to main content

SpatialService

nominal_api::endpoints::scout::spatial::spatial_service

Trait SpatialService 

Source 
pub trait SpatialService {
    // Required methods
    fn get(
        &self,
        auth_: BearerToken,
        spatial_rid: SpatialRid,
    ) -> Result<Spatial, Error>;
    fn batch_get(
        &self,
        auth_: BearerToken,
        request: GetSpatialsRequest,
    ) -> Result<GetSpatialsResponse, Error>;
    fn search(
        &self,
        auth_: BearerToken,
        request: SearchSpatialsRequest,
    ) -> Result<SearchSpatialsResponse, Error>;
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateSpatialRequest,
    ) -> Result<Spatial, Error>;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        spatial_rid: SpatialRid,
        request: UpdateSpatialMetadataRequest,
    ) -> Result<Spatial, Error>;
    fn get_ingest_status(
        &self,
        auth_: BearerToken,
        spatial_rid: SpatialRid,
    ) -> Result<SpatialIngestStatus, Error>;
    fn batch_get_ingest_status(
        &self,
        auth_: BearerToken,
        spatial_rids: BTreeSet<SpatialRid>,
    ) -> Result<BTreeMap<SpatialRid, SpatialIngestStatus>, Error>;
    fn archive(
        &self,
        auth_: BearerToken,
        spatial_rid: SpatialRid,
    ) -> Result<(), Error>;
    fn unarchive(
        &self,
        auth_: BearerToken,
        spatial_rid: SpatialRid,
    ) -> Result<(), Error>;
    fn import_file(
        &self,
        auth_: BearerToken,
        request: ImportFileRequest,
    ) -> Result<ImportFileResponse, Error>;
}
Expand description

The spatial asset service manages spatial assets (point clouds, etc.) and their metadata. Spatial asset data is stored in Dagger; Scout tracks metadata and references.

Required Methods§

Source

fn get( &self, auth_: BearerToken, spatial_rid: SpatialRid, ) -> Result<Spatial, Error>

Returns spatial asset metadata associated with a spatial asset rid.

Source

fn batch_get( &self, auth_: BearerToken, request: GetSpatialsRequest, ) -> Result<GetSpatialsResponse, Error>

Returns spatial asset metadata for each given spatial asset rid.

Source

fn search( &self, auth_: BearerToken, request: SearchSpatialsRequest, ) -> Result<SearchSpatialsResponse, Error>

Returns metadata about spatial assets that match a given query.

Source

fn create( &self, auth_: BearerToken, request: CreateSpatialRequest, ) -> Result<Spatial, Error>

Creates and persists a spatial asset entity with the given metadata.

Source

fn update_metadata( &self, auth_: BearerToken, spatial_rid: SpatialRid, request: UpdateSpatialMetadataRequest, ) -> Result<Spatial, Error>

Updates the metadata for a spatial asset associated with the given rid.

Source

fn get_ingest_status( &self, auth_: BearerToken, spatial_rid: SpatialRid, ) -> Result<SpatialIngestStatus, Error>

Source

fn batch_get_ingest_status( &self, auth_: BearerToken, spatial_rids: BTreeSet<SpatialRid>, ) -> Result<BTreeMap<SpatialRid, SpatialIngestStatus>, Error>

Source

fn archive( &self, auth_: BearerToken, spatial_rid: SpatialRid, ) -> Result<(), Error>

Archives a spatial asset, excluding it from search. Can be unarchived.

Source

fn unarchive( &self, auth_: BearerToken, spatial_rid: SpatialRid, ) -> Result<(), Error>

Unarchives a previously archived spatial asset.

Source

fn import_file( &self, auth_: BearerToken, request: ImportFileRequest, ) -> Result<ImportFileResponse, Error>

Imports a spatial data file (e.g. LAS, LAZ, PLY, PCAP). Creates a new spatial asset, processes the file, and uploads the extracted data to Dagger.

Implementors§