Data Acquisition Store¶
Client implementation for data acquisition store service.
- class bosdyn.client.data_acquisition_store.DataAcquisitionStoreClient[source]¶
Bases:
BaseClient
A client for triggering data acquisition store methods.
- default_service_name = 'data-acquisition-store'¶
- service_type = 'bosdyn.api.DataAcquisitionStoreService'¶
- list_capture_actions(query, **kwargs)[source]¶
List capture actions that satisfy the query parameters.
- Parameters
query (bosdyn.api.DataQueryParams) – Query parameters.
- Returns
CaptureActionIds for the actions matching the query parameters.
- list_capture_actions_async(query, **kwargs)[source]¶
Async version of the list_capture_actions() RPC.
- list_stored_images(query, **kwargs)[source]¶
List images that satisfy the query parameters.
- Parameters
query (bosdyn.api.DataQueryParams) – Query parameters.
- Returns
DataIdentifiers for the images matching the query parameters.
- list_stored_images_async(query, **kwargs)[source]¶
Async version of the list_stored_images_actions() RPC.
- list_stored_metadata(query, **kwargs)[source]¶
List metadata that satisfy the query parameters.
- Parameters
query (bosdyn.api.DataQueryParams) – Query parameters.
- Returns
DataIdentifiers for the metadata matching the query parameters.
- list_stored_metadata_async(query, **kwargs)[source]¶
Async version of the list_stored_metadata() RPC.
- list_stored_alertdata(query, **kwargs)[source]¶
List AlertData that satisfy the query parameters.
- Parameters
query (bosdyn.api.DataQueryParams) – Query parameters.
- Returns
DataIdentifiers for the AlertData matching the query parameters.
- list_stored_alertdata_async(query, **kwargs)[source]¶
Async version of the list_stored_alertdata() RPC.
- list_stored_data(query, **kwargs)[source]¶
List data that satisfy the query parameters.
- Parameters
query (bosdyn.api.DataQueryParams) – Query parameters.
- Returns
DataIdentifiers for the data matching the query parameters.
- store_image(image, data_id, **kwargs)[source]¶
Store image.
- Parameters
image (bosdyn.api.ImageCapture) – Image to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing the image.
- Returns
StoreImageResponse response.
- store_metadata(associated_metadata, data_id, **kwargs)[source]¶
Store metadata.
- Parameters
associated_metadata (bosdyn.api.AssociatedMetadata) – Metadata to store. If metadata is not associated with a particular piece of data, the data_id field in this object needs to specify only the action_id part.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this associated metadata.
- Returns
StoreMetadataResponse response.
- store_metadata_async(associated_metadata, data_id, **kwargs)[source]¶
Async version of the store_metadata() RPC.
- store_alertdata(associated_alert_data, data_id, **kwargs)[source]¶
Store AlertData.
- Parameters
associated_alert_data (bosdyn.api.AssociatedAlertData) – AlertData to store. If AlertData is not associated with a particular piece of data, the data_id field in this object needs to specify only the action_id part.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this associated AlertData.
- Returns
StoreAlertDataResponse response.
- store_alertdata_async(associated_alert_data, data_id, **kwargs)[source]¶
Async version of the store_alertdata() RPC.
- store_data(data, data_id, file_extension=None, **kwargs)[source]¶
Store data.
- Parameters
data (bytes) – Arbitrary data to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this data.
file_extension (string) – File extension to use for writing the data to a file.
- Returns
StoreDataResponse response.