spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
62 lines • 4.08 kB
TypeScript
import { ListCaptureActionsResponse, ListStoredDataResponse, StoreDataResponse, ListStoredImagesResponse, StoreImageResponse, ListStoredMetadataResponse, StoreMetadataResponse, ListStoredAlertDataResponse, StoreAlertDataResponse, ListCaptureActionsRequest, ListStoredDataRequest, StoreDataRequest, ListStoredImagesRequest, StoreImageRequest, ListStoredMetadataRequest, StoreMetadataRequest, ListStoredAlertDataRequest, StoreAlertDataRequest } from "./data_acquisition_store";
export declare const protobufPackage = "bosdyn.api";
/**
* The DataAcquisitionStoreService is used to store data (images, data, metadata) on the robot
* in association with the DataIdentifiers specified by the DataAcquisitionService. Additionally,
* requests can be made to the DataAcquisitionStoreService to identify different pieces of data or entire
* capture actions which match query parameters, such as time ranges or action/group names.
*/
export interface DataAcquisitionStoreService {
/**
* List all CaptureActionIds (which identify an entire AcquireData RPC's data captures)
* that match the query parameters provided in the request.
*/
ListCaptureActions(request: ListCaptureActionsRequest): Promise<ListCaptureActionsResponse>;
/**
* List data identifiers (which identify specific pieces of data from
* an action) for stored data that satisfy the query parameters in the request.
*/
ListStoredData(request: ListStoredDataRequest): Promise<ListStoredDataResponse>;
/** Store arbitrary data associated with a DataIdentifier. */
StoreData(request: StoreDataRequest): Promise<StoreDataResponse>;
/**
* Type-safe to images: list data identifiers (which identify specific images
* from an action) for stored images that satisfy the
* query parameters in the request.
*/
ListStoredImages(request: ListStoredImagesRequest): Promise<ListStoredImagesResponse>;
/** Type-safe to images: store image data associated with a DataIdentifier. */
StoreImage(request: StoreImageRequest): Promise<StoreImageResponse>;
/**
* Type-safe to JSON metadata: list data identifiers (which identify specific metadata from
* an action) for stored metadata that satisfy the query parameters in the request.
*/
ListStoredMetadata(request: ListStoredMetadataRequest): Promise<ListStoredMetadataResponse>;
/** Type-safe to JSON metadata: store metadata associated with a DataIdentifier. */
StoreMetadata(request: StoreMetadataRequest): Promise<StoreMetadataResponse>;
/**
* List data identifiers (which identify specific AlertData from
* an action) for stored AlertData that satisfy the query parameters in the request.
*/
ListStoredAlertData(request: ListStoredAlertDataRequest): Promise<ListStoredAlertDataResponse>;
/** Store AlertData associated with a DataIdentifier. */
StoreAlertData(request: StoreAlertDataRequest): Promise<StoreAlertDataResponse>;
}
export declare class DataAcquisitionStoreServiceClientImpl implements DataAcquisitionStoreService {
private readonly rpc;
constructor(rpc: Rpc);
ListCaptureActions(request: ListCaptureActionsRequest): Promise<ListCaptureActionsResponse>;
ListStoredData(request: ListStoredDataRequest): Promise<ListStoredDataResponse>;
StoreData(request: StoreDataRequest): Promise<StoreDataResponse>;
ListStoredImages(request: ListStoredImagesRequest): Promise<ListStoredImagesResponse>;
StoreImage(request: StoreImageRequest): Promise<StoreImageResponse>;
ListStoredMetadata(request: ListStoredMetadataRequest): Promise<ListStoredMetadataResponse>;
StoreMetadata(request: StoreMetadataRequest): Promise<StoreMetadataResponse>;
ListStoredAlertData(request: ListStoredAlertDataRequest): Promise<ListStoredAlertDataResponse>;
StoreAlertData(request: StoreAlertDataRequest): Promise<StoreAlertDataResponse>;
}
interface Rpc {
request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
}
export {};
//# sourceMappingURL=data_acquisition_store_service.d.ts.map