Documentation Github spot-sdk-js Github spot-server-js

Class

DataAcquisitionStoreClient

DataAcquisitionStoreClient(namenullable)

Constructor

# new DataAcquisitionStoreClient(namenullable)

Create an instance of DataAcquisitionStoreClient's class.
Parameters:
Name Type Attributes Default Description
name string <nullable>
 null Class name.

View Source bosdyn-client/data_acquisition_store.js, line 21

Methods

# list_capture_actions(query, argsopt) → {Promise.<(Array|Object)>}

List capture actions that satisfy the query parameters.
Parameters:
Name Type Attributes Description
query data_acquisition_store.DataQueryParams Query parameters.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 47

CaptureActionIds for the actions matching the query parameters.
Promise.<(Array|Object)>

# list_stored_data(query, argsopt) → {Promise.<(Array|Object)>}

List data that satisfy the query parameters.
Parameters:
Name Type Attributes Description
query data_acquisition_store.DataQueryParams Query parameters.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 80

DataIdentifiers for the images matching the query parameters.
Promise.<(Array|Object)>

# list_stored_images(query, argsopt) → {Promise.<(Array|Object)>}

List images that satisfy the query parameters.
Parameters:
Name Type Attributes Description
query data_acquisition_store.DataQueryParams Query parameters.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 58

DataIdentifiers for the images matching the query parameters.
Promise.<(Array|Object)>

# list_stored_metadata(query, argsopt) → {Promise.<(Array|Object)>}

List metadata that satisfy the query parameters.
Parameters:
Name Type Attributes Description
query data_acquisition_store.DataQueryParams Query parameters.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 69

DataIdentifiers for the images matching the query parameters.
Promise.<(Array|Object)>

# store_data(datanon-null, data_id, file_extensionopt, nullable, argsopt) → {Promise.<data_acquisition_store.StoreDataResponse>}

Store data.
Parameters:
Name Type Attributes Default Description
data string | Uint8Array Arbitrary data to store.
data_id data_acquisition_pb.DataIdentifier Data identifier to use for storing this data.
file_extension string <optional>
<nullable>
 null File extension to use for writing the data to a file.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 122

StoreDataResponse response.
Promise.<data_acquisition_store.StoreDataResponse>

# store_image(image, data_id, argsopt) → {Promise.<data_acquisition_store.StoreImageResponse>}

Store image.
Parameters:
Name Type Attributes Description
image image_pb.ImageCapture Image to store.
data_id data_acquisition_pb.DataIdentifier Data identifier to use for storing the image.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 92

StoreImageResponse response.
Promise.<data_acquisition_store.StoreImageResponse>

# store_metadata(associated_metadata, data_id, argsopt) → {Promise.<data_acquisition_store.StoreMetadataResponse>}

Store metadata.
Parameters:
Name Type Attributes Description
associated_metadata data_acquisition_pb.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 data_acquisition_pb.DataIdentifier Data identifier to use for storing this associated metadata.
args Object <optional>
 Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_store.js, line 107

StoreMetadataResponse response.
Promise.<data_acquisition_store.StoreMetadataResponse>

# async update_from(other) → {Promise.<void>}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/data_acquisition_store.js, line 31

Promise.<void>