ni.measurements.data.v1.client

Public API for accessing the NI Data Store Service.

Classes

DataStoreClient

Client for accessing the NI Data Store Service.

Package Contents

class ni.measurements.data.v1.client.DataStoreClient(*, discovery_client=None, grpc_channel=None, grpc_channel_pool=None)[source]

Bases: ni.measurements.data.v1.client._client_base.GrpcServiceClientBase[ni.measurements.data.v1.data_store_service_pb2_grpc.DataStoreServiceStub]

Client for accessing the NI Data Store Service.

Initialize the Data Store Client.

Parameters:

discovery_client (ni.measurementlink.discovery.v1.client.DiscoveryClient | None) – An optional discovery client (recommended).
grpc_channel (grpc.Channel | None) – An optional data store gRPC channel.
grpc_channel_pool (ni_grpc_extensions.channelpool.GrpcChannelPool | None) – An optional gRPC channel pool (recommended).

__slots__ = ()

create_test_result(request)[source]

Create a test result object for publishing measurements.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.CreateTestResultRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.CreateTestResultResponse

get_test_result(request)[source]

Get the test result associated with the identifier given in the request.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.GetTestResultRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.GetTestResultResponse

query_test_results(request)[source]

Query for test results matching the given OData query.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.QueryTestResultsRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.QueryTestResultsResponse

create_step(request)[source]

Create a new step in the data store.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.CreateStepRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.CreateStepResponse

get_step(request)[source]

Get the step associated with the identifier given in the request.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.GetStepRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.GetStepResponse

query_steps(request)[source]

Query for steps matching the given OData query.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.QueryStepsRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.QueryStepsResponse

publish_condition(request)[source]

Publish a single condition value for a step.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.PublishConditionRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.PublishConditionResponse

publish_condition_batch(request)[source]

Publish multiple condition values at once for parametric sweeps.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.PublishConditionBatchRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.PublishConditionBatchResponse

publish_measurement(request)[source]

Publish a single measurement value associated with a step.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementResponse

publish_measurement_batch(request)[source]

Publish multiple measurement values at once for parametric sweeps.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementBatchRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementBatchResponse

get_measurement(request)[source]

Get the measurement associated with the identifier given in the request.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.GetMeasurementRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.GetMeasurementResponse

get_condition(request)[source]

Get the condition associated with the identifier given in the request.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.GetConditionRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.GetConditionResponse

query_conditions(request)[source]

Query conditions using OData query syntax.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.QueryConditionsRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.QueryConditionsResponse

query_measurements(request)[source]

Query measurements using OData query syntax.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.QueryMeasurementsRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.QueryMeasurementsResponse

read_condition_value(request)[source]

Read the value of a condition.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.ReadConditionValueRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.ReadConditionValueResponse

read_measurement_value(request)[source]

Read the value of a measurement.

Parameters:: request (ni.measurements.data.v1.data_store_service_pb2.ReadMeasurementValueRequest)
Return type:: ni.measurements.data.v1.data_store_service_pb2.ReadMeasurementValueResponse