ni.measurements.data.v1.data_store_service_pb2

Attributes

`DESCRIPTOR`
`global___CreateTestResultRequest`
`global___CreateTestResultResponse`
`global___GetTestResultRequest`
`global___GetTestResultResponse`
`global___QueryTestResultsRequest`
`global___QueryTestResultsResponse`
`global___CreateStepRequest`
`global___CreateStepResponse`
`global___GetStepRequest`
`global___GetStepResponse`
`global___QueryStepsRequest`
`global___QueryStepsResponse`
`global___PublishConditionRequest`
`global___PublishConditionResponse`
`global___PublishConditionBatchRequest`
`global___PublishConditionBatchResponse`
`global___PublishMeasurementRequest`
`global___PublishMeasurementResponse`
`global___PublishMeasurementBatchRequest`
`global___PublishMeasurementBatchResponse`
`global___GetMeasurementRequest`
`global___GetMeasurementResponse`
`global___GetConditionRequest`
`global___GetConditionResponse`
`global___QueryConditionsRequest`
`global___QueryConditionsResponse`
`global___QueryMeasurementsRequest`
`global___QueryMeasurementsResponse`
`global___ReadConditionValueRequest`
`global___ReadConditionValueResponse`
`global___ReadMeasurementValueRequest`
`global___ReadMeasurementValueResponse`

Classes

`CreateTestResultRequest`	Abstract base class for protocol messages.
`CreateTestResultResponse`	Abstract base class for protocol messages.
`GetTestResultRequest`	Abstract base class for protocol messages.
`GetTestResultResponse`	Abstract base class for protocol messages.
`QueryTestResultsRequest`	Abstract base class for protocol messages.
`QueryTestResultsResponse`	Abstract base class for protocol messages.
`CreateStepRequest`	Abstract base class for protocol messages.
`CreateStepResponse`	Abstract base class for protocol messages.
`GetStepRequest`	Message sent to get the step associated with the given identifier.
`GetStepResponse`	Message returned when getting a step associated with the given identifier.
`QueryStepsRequest`	Abstract base class for protocol messages.
`QueryStepsResponse`	Abstract base class for protocol messages.
`PublishConditionRequest`	Abstract base class for protocol messages.
`PublishConditionResponse`	Abstract base class for protocol messages.
`PublishConditionBatchRequest`	Abstract base class for protocol messages.
`PublishConditionBatchResponse`	Abstract base class for protocol messages.
`PublishMeasurementRequest`	Abstract base class for protocol messages.
`PublishMeasurementResponse`	Abstract base class for protocol messages.
`PublishMeasurementBatchRequest`	Abstract base class for protocol messages.
`PublishMeasurementBatchResponse`	Abstract base class for protocol messages.
`GetMeasurementRequest`	Abstract base class for protocol messages.
`GetMeasurementResponse`	Abstract base class for protocol messages.
`GetConditionRequest`	Abstract base class for protocol messages.
`GetConditionResponse`	Abstract base class for protocol messages.
`QueryConditionsRequest`	Abstract base class for protocol messages.
`QueryConditionsResponse`	Abstract base class for protocol messages.
`QueryMeasurementsRequest`	Abstract base class for protocol messages.
`QueryMeasurementsResponse`	Abstract base class for protocol messages.
`ReadConditionValueRequest`	Abstract base class for protocol messages.
`ReadConditionValueResponse`	Abstract base class for protocol messages.
`ReadMeasurementValueRequest`	Abstract base class for protocol messages.
`ReadMeasurementValueResponse`	Abstract base class for protocol messages.

Package Contents

ni.measurements.data.v1.data_store_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.measurements.data.v1.data_store_service_pb2.CreateTestResultRequest(*, test_result=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: test_result (ni.measurements.data.v1.data_store_pb2.TestResult | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

TEST_RESULT_FIELD_NUMBER: int

property test_result: ni.measurements.data.v1.data_store_pb2.TestResult

The metadata of the test result to be created.

Return type:: ni.measurements.data.v1.data_store_pb2.TestResult

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___CreateTestResultRequest

class ni.measurements.data.v1.data_store_service_pb2.CreateTestResultResponse(*, test_result_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: test_result_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

TEST_RESULT_ID_FIELD_NUMBER: int

test_result_id: str: The test result id. Generated if not specified in the request.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___CreateTestResultResponse

class ni.measurements.data.v1.data_store_service_pb2.GetTestResultRequest(*, test_result_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: test_result_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

TEST_RESULT_ID_FIELD_NUMBER: int

test_result_id: str: The id of the desired test result. This value is expected to be a parsable GUID.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetTestResultRequest

class ni.measurements.data.v1.data_store_service_pb2.GetTestResultResponse(*, test_result=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: test_result (ni.measurements.data.v1.data_store_pb2.TestResult | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

TEST_RESULT_FIELD_NUMBER: int

property test_result: ni.measurements.data.v1.data_store_pb2.TestResult

The TestResult object that corresponds to the requested id.

Return type:: ni.measurements.data.v1.data_store_pb2.TestResult

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetTestResultResponse

class ni.measurements.data.v1.data_store_service_pb2.QueryTestResultsRequest(*, odata_query=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: odata_query (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ODATA_QUERY_FIELD_NUMBER: int

odata_query: str: an OData query string. example “$filter=name eq ‘Value’” An empty string will return all test results. $expand, $count, and $select are not supported. For more information, see https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryTestResultsRequest

class ni.measurements.data.v1.data_store_service_pb2.QueryTestResultsResponse(*, test_results=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: test_results (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.TestResult] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

TEST_RESULTS_FIELD_NUMBER: int

property test_results: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.TestResult]

The list of test results that match the query.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.TestResult]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryTestResultsResponse

class ni.measurements.data.v1.data_store_service_pb2.CreateStepRequest(*, step=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: step (ni.measurements.data.v1.data_store_pb2.Step | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STEP_FIELD_NUMBER: int

property step: ni.measurements.data.v1.data_store_pb2.Step

Required. The metadata of the step to be created.

Return type:: ni.measurements.data.v1.data_store_pb2.Step

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___CreateStepRequest

class ni.measurements.data.v1.data_store_service_pb2.CreateStepResponse(*, step_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: step_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STEP_ID_FIELD_NUMBER: int

step_id: str: The identifier of the created step.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___CreateStepResponse

class ni.measurements.data.v1.data_store_service_pb2.GetStepRequest(*, step_id=...)

Bases: google.protobuf.message.Message

Message sent to get the step associated with the given identifier.

Parameters:: step_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STEP_ID_FIELD_NUMBER: int

step_id: str: Required. The identifier of the desired step.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetStepRequest

class ni.measurements.data.v1.data_store_service_pb2.GetStepResponse(*, step=...)

Bases: google.protobuf.message.Message

Message returned when getting a step associated with the given identifier.

Parameters:: step (ni.measurements.data.v1.data_store_pb2.Step | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STEP_FIELD_NUMBER: int

property step: ni.measurements.data.v1.data_store_pb2.Step

The metadata of the requested step.

Return type:: ni.measurements.data.v1.data_store_pb2.Step

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetStepResponse

class ni.measurements.data.v1.data_store_service_pb2.QueryStepsRequest(*, odata_query=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: odata_query (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ODATA_QUERY_FIELD_NUMBER: int

odata_query: str: an OData query string. example “$filter=name eq ‘Value’” An empty string will return all steps. $expand, $count, and $select are not supported. For more information, see https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryStepsRequest

class ni.measurements.data.v1.data_store_service_pb2.QueryStepsResponse(*, steps=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: steps (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.Step] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STEPS_FIELD_NUMBER: int

property steps: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.Step]

The list of steps that match the query.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.Step]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryStepsResponse

class ni.measurements.data.v1.data_store_service_pb2.PublishConditionRequest(*, name=..., condition_type=..., scalar=..., step_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
condition_type (str)
scalar (ni.protobuf.types.scalar_pb2.Scalar | None)
step_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

CONDITION_TYPE_FIELD_NUMBER: int

SCALAR_FIELD_NUMBER: int

STEP_ID_FIELD_NUMBER: int

name: str: Required. Identifier describing the condition value. For example, “Voltage”.

condition_type: str: Optional. The type of this condition. For example, “Upper Limit” or “Environment”.

step_id: str: Required. The id of the step associated with this condition. This value is expected to be a parsable GUID.

property scalar: ni.protobuf.types.scalar_pb2.Scalar

Return type:: ni.protobuf.types.scalar_pb2.Scalar

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___PublishConditionRequest

class ni.measurements.data.v1.data_store_service_pb2.PublishConditionResponse(*, condition_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: condition_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONDITION_ID_FIELD_NUMBER: int

condition_id: str: The id of the published condition.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___PublishConditionResponse

class ni.measurements.data.v1.data_store_service_pb2.PublishConditionBatchRequest(*, name=..., condition_type=..., scalar_values=..., step_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
condition_type (str)
scalar_values (ni.protobuf.types.vector_pb2.Vector | None)
step_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

CONDITION_TYPE_FIELD_NUMBER: int

SCALAR_VALUES_FIELD_NUMBER: int

STEP_ID_FIELD_NUMBER: int

name: str: Required. Identifier describing the condition values. For example, “Voltage”.

condition_type: str: Optional. The type of this condition. For example, “Upper Limit” or “Environment”.

step_id: str: Required. The id of the step associated with this batch of condition values. This value is expected to be a parsable GUID.

property scalar_values: ni.protobuf.types.vector_pb2.Vector

Return type:: ni.protobuf.types.vector_pb2.Vector

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___PublishConditionBatchRequest

class ni.measurements.data.v1.data_store_service_pb2.PublishConditionBatchResponse(*, condition_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: condition_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONDITION_ID_FIELD_NUMBER: int

condition_id: str: The id of the published condition.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___PublishConditionBatchResponse

class ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementRequest(*, name=..., scalar=..., vector=..., double_analog_waveform=..., x_y_data=..., i16_analog_waveform=..., double_complex_waveform=..., i16_complex_waveform=..., double_spectrum=..., digital_waveform=..., notes=..., timestamp=..., outcome=..., error_information=..., step_id=..., hardware_item_ids=..., test_adapter_ids=..., software_item_ids=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
scalar (ni.protobuf.types.scalar_pb2.Scalar | None)
vector (ni.protobuf.types.vector_pb2.Vector | None)
double_analog_waveform (ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform | None)
x_y_data (ni.protobuf.types.xydata_pb2.DoubleXYData | None)
i16_analog_waveform (ni.protobuf.types.waveform_pb2.I16AnalogWaveform | None)
double_complex_waveform (ni.protobuf.types.waveform_pb2.DoubleComplexWaveform | None)
i16_complex_waveform (ni.protobuf.types.waveform_pb2.I16ComplexWaveform | None)
double_spectrum (ni.protobuf.types.waveform_pb2.DoubleSpectrum | None)
digital_waveform (ni.protobuf.types.waveform_pb2.DigitalWaveform | None)
notes (str)
timestamp (ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp | None)
outcome (ni.measurements.data.v1.data_store_pb2.Outcome.ValueType)
error_information (ni.measurements.data.v1.data_store_pb2.ErrorInformation | None)
step_id (str)
hardware_item_ids (collections.abc.Iterable[str] | None)
test_adapter_ids (collections.abc.Iterable[str] | None)
software_item_ids (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

SCALAR_FIELD_NUMBER: int

VECTOR_FIELD_NUMBER: int

DOUBLE_ANALOG_WAVEFORM_FIELD_NUMBER: int

X_Y_DATA_FIELD_NUMBER: int

I16_ANALOG_WAVEFORM_FIELD_NUMBER: int

DOUBLE_COMPLEX_WAVEFORM_FIELD_NUMBER: int

I16_COMPLEX_WAVEFORM_FIELD_NUMBER: int

DOUBLE_SPECTRUM_FIELD_NUMBER: int

DIGITAL_WAVEFORM_FIELD_NUMBER: int

NOTES_FIELD_NUMBER: int

TIMESTAMP_FIELD_NUMBER: int

OUTCOME_FIELD_NUMBER: int

ERROR_INFORMATION_FIELD_NUMBER: int

STEP_ID_FIELD_NUMBER: int

HARDWARE_ITEM_IDS_FIELD_NUMBER: int

TEST_ADAPTER_IDS_FIELD_NUMBER: int

SOFTWARE_ITEM_IDS_FIELD_NUMBER: int

name: str: Required for measurement. This name is used for associating/grouping conceptually alike measurements across multiple publish iterations. For example, a shared name of “Temperature” can be used for associating temperature readings across multiple iterations of publishing.

notes: str: Optional. Any notes to be associated with the captured measurement.

outcome: ni.measurements.data.v1.data_store_pb2.Outcome.ValueType: Optional. The outcome of the measurement.

step_id: str: Required. The id of the step associated with this measurement. This value is expected to be a parsable GUID.

property scalar: ni.protobuf.types.scalar_pb2.Scalar

Return type:: ni.protobuf.types.scalar_pb2.Scalar

property vector: ni.protobuf.types.vector_pb2.Vector

Return type:: ni.protobuf.types.vector_pb2.Vector

property double_analog_waveform: ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform

Return type:: ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform

property x_y_data: ni.protobuf.types.xydata_pb2.DoubleXYData

Return type:: ni.protobuf.types.xydata_pb2.DoubleXYData

property i16_analog_waveform: ni.protobuf.types.waveform_pb2.I16AnalogWaveform

Return type:: ni.protobuf.types.waveform_pb2.I16AnalogWaveform

property double_complex_waveform: ni.protobuf.types.waveform_pb2.DoubleComplexWaveform

Return type:: ni.protobuf.types.waveform_pb2.DoubleComplexWaveform

property i16_complex_waveform: ni.protobuf.types.waveform_pb2.I16ComplexWaveform

Return type:: ni.protobuf.types.waveform_pb2.I16ComplexWaveform

property double_spectrum: ni.protobuf.types.waveform_pb2.DoubleSpectrum

Return type:: ni.protobuf.types.waveform_pb2.DoubleSpectrum

property digital_waveform: ni.protobuf.types.waveform_pb2.DigitalWaveform

Return type:: ni.protobuf.types.waveform_pb2.DigitalWaveform

property timestamp: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

Optional. The timestamp of the measurement.

Return type:: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property error_information: ni.measurements.data.v1.data_store_pb2.ErrorInformation

Optional. Error or exception information in JSON format.

Return type:: ni.measurements.data.v1.data_store_pb2.ErrorInformation

property hardware_item_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the hardware items associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property test_adapter_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the test adapters associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property software_item_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the software items associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___PublishMeasurementRequest

class ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementResponse(*, measurement_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: measurement_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MEASUREMENT_ID_FIELD_NUMBER: int

measurement_id: str: The id of the published measurement.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___PublishMeasurementResponse

class ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementBatchRequest(*, name=..., scalar_values=..., vector_values=..., double_analog_waveform_values=..., x_y_data_values=..., i16_analog_waveform_values=..., double_complex_waveform_values=..., i16_complex_waveform_values=..., double_spectrum_values=..., digital_waveform_values=..., notes=..., timestamps=..., outcomes=..., error_information=..., step_id=..., hardware_item_ids=..., test_adapter_ids=..., software_item_ids=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
scalar_values (ni.protobuf.types.vector_pb2.Vector | None)
vector_values (ni.protobuf.types.vector_wrappers_pb2.VectorArrayValue | None)
double_analog_waveform_values (ni.protobuf.types.waveform_wrappers_pb2.DoubleAnalogWaveformArrayValue | None)
x_y_data_values (ni.protobuf.types.xydata_wrappers_pb2.DoubleXYDataArrayValue | None)
i16_analog_waveform_values (ni.protobuf.types.waveform_wrappers_pb2.I16AnalogWaveformArrayValue | None)
double_complex_waveform_values (ni.protobuf.types.waveform_wrappers_pb2.DoubleComplexWaveformArrayValue | None)
i16_complex_waveform_values (ni.protobuf.types.waveform_wrappers_pb2.I16ComplexWaveformArrayValue | None)
double_spectrum_values (ni.protobuf.types.waveform_wrappers_pb2.DoubleSpectrumArrayValue | None)
digital_waveform_values (ni.protobuf.types.waveform_wrappers_pb2.DigitalWaveformArrayValue | None)
notes (str)
timestamps (collections.abc.Iterable[ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp] | None)
outcomes (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.Outcome.ValueType] | None)
error_information (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.ErrorInformation] | None)
step_id (str)
hardware_item_ids (collections.abc.Iterable[str] | None)
test_adapter_ids (collections.abc.Iterable[str] | None)
software_item_ids (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

SCALAR_VALUES_FIELD_NUMBER: int

VECTOR_VALUES_FIELD_NUMBER: int

DOUBLE_ANALOG_WAVEFORM_VALUES_FIELD_NUMBER: int

X_Y_DATA_VALUES_FIELD_NUMBER: int

I16_ANALOG_WAVEFORM_VALUES_FIELD_NUMBER: int

DOUBLE_COMPLEX_WAVEFORM_VALUES_FIELD_NUMBER: int

I16_COMPLEX_WAVEFORM_VALUES_FIELD_NUMBER: int

DOUBLE_SPECTRUM_VALUES_FIELD_NUMBER: int

DIGITAL_WAVEFORM_VALUES_FIELD_NUMBER: int

NOTES_FIELD_NUMBER: int

TIMESTAMPS_FIELD_NUMBER: int

OUTCOMES_FIELD_NUMBER: int

ERROR_INFORMATION_FIELD_NUMBER: int

STEP_ID_FIELD_NUMBER: int

HARDWARE_ITEM_IDS_FIELD_NUMBER: int

TEST_ADAPTER_IDS_FIELD_NUMBER: int

SOFTWARE_ITEM_IDS_FIELD_NUMBER: int

name: str: Required for measurement. This name is used for associating/grouping conceptually alike measurements across multiple publish iterations. For example, a shared name of “Temperature” can be used for associating temperature readings across multiple iterations of publishing.

notes: str: Optional. Any notes to be associated with the captured measurement.

step_id: str: Required. The id of the step associated with this measurement. This value is expected to be a parsable GUID.

property scalar_values: ni.protobuf.types.vector_pb2.Vector

Scalar values packed into a vector (e.g., N doubles in a DoubleArray).

Return type:: ni.protobuf.types.vector_pb2.Vector

property vector_values: ni.protobuf.types.vector_wrappers_pb2.VectorArrayValue

N vector values, one per iteration.

Return type:: ni.protobuf.types.vector_wrappers_pb2.VectorArrayValue

property double_analog_waveform_values: ni.protobuf.types.waveform_wrappers_pb2.DoubleAnalogWaveformArrayValue

N double-precision analog waveforms, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.DoubleAnalogWaveformArrayValue

property x_y_data_values: ni.protobuf.types.xydata_wrappers_pb2.DoubleXYDataArrayValue

N XY data sets, one per iteration.

Return type:: ni.protobuf.types.xydata_wrappers_pb2.DoubleXYDataArrayValue

property i16_analog_waveform_values: ni.protobuf.types.waveform_wrappers_pb2.I16AnalogWaveformArrayValue

N 16-bit integer analog waveforms, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.I16AnalogWaveformArrayValue

property double_complex_waveform_values: ni.protobuf.types.waveform_wrappers_pb2.DoubleComplexWaveformArrayValue

N double-precision complex waveforms, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.DoubleComplexWaveformArrayValue

property i16_complex_waveform_values: ni.protobuf.types.waveform_wrappers_pb2.I16ComplexWaveformArrayValue

N 16-bit integer complex waveforms, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.I16ComplexWaveformArrayValue

property double_spectrum_values: ni.protobuf.types.waveform_wrappers_pb2.DoubleSpectrumArrayValue

N double-precision spectrums, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.DoubleSpectrumArrayValue

property digital_waveform_values: ni.protobuf.types.waveform_wrappers_pb2.DigitalWaveformArrayValue

N digital waveforms, one per iteration.

Return type:: ni.protobuf.types.waveform_wrappers_pb2.DigitalWaveformArrayValue

property timestamps: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp]

Optional. The timestamps corresponding to the N iterations of batched measurement being published. This field must meet one of the following requirements:

The field may be empty. (No timestamp information is recorded for the measurement.)

The field may contain a single value. This value will be associated with each value of the batched measurement.

The field may contain N values, where N is the number of individual batched measurements being published. In this case, each timestamp aligns with the scalar value at the corresponding index within the vector.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp]

property outcomes: google.protobuf.internal.containers.RepeatedScalarFieldContainer[ni.measurements.data.v1.data_store_pb2.Outcome.ValueType]

Optional. The outcomes corresponding to the N iterations of batched measurement being published. This field must meet one of the following requirements:

The field may be empty. (No outcome information is recorded for the measurement.)

The field may contain a single value. This value will be associated with each value of the batched measurement.

The field may contain N values, where N is the number of individual batched measurements being published. In this case, each outcome aligns with the scalar value at the corresponding index within the vector.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[ni.measurements.data.v1.data_store_pb2.Outcome.ValueType]

property error_information: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.ErrorInformation]

Optional. The error information corresponding to the N iterations of batched measurement being published. This field must meet one of the following requirements:

The field may be empty. (No error information is recorded for the measurement.)

The field may contain a single value. This value will be associated with each value of the batched measurement.

The field may contain N values, where N is the number of individual batched measurements being published. In this case, each error information aligns with the scalar value at the corresponding index within the vector.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.ErrorInformation]

property hardware_item_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the hardware items associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property test_adapter_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the test adapters associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property software_item_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. The ids of the software items associated with this measurement. These values are expected to be parsable GUIDs or aliases.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___PublishMeasurementBatchRequest

class ni.measurements.data.v1.data_store_service_pb2.PublishMeasurementBatchResponse(*, measurement_ids=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: measurement_ids (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MEASUREMENT_IDS_FIELD_NUMBER: int

property measurement_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

The ids of the published measurements. If your batch contained scalar data, this will be a single value.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___PublishMeasurementBatchResponse

class ni.measurements.data.v1.data_store_service_pb2.GetMeasurementRequest(*, measurement_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: measurement_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MEASUREMENT_ID_FIELD_NUMBER: int

measurement_id: str: The id of the desired measurement. This value is expected to be a parsable GUID.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetMeasurementRequest

class ni.measurements.data.v1.data_store_service_pb2.GetMeasurementResponse(*, published_measurement=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: published_measurement (ni.measurements.data.v1.data_store_pb2.PublishedMeasurement | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PUBLISHED_MEASUREMENT_FIELD_NUMBER: int

property published_measurement: ni.measurements.data.v1.data_store_pb2.PublishedMeasurement

The measurement associated with the given id.

Return type:: ni.measurements.data.v1.data_store_pb2.PublishedMeasurement

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetMeasurementResponse

class ni.measurements.data.v1.data_store_service_pb2.GetConditionRequest(*, condition_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: condition_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONDITION_ID_FIELD_NUMBER: int

condition_id: str: The id of the desired condition. This value is expected to be a parsable GUID.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetConditionRequest

class ni.measurements.data.v1.data_store_service_pb2.GetConditionResponse(*, published_condition=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: published_condition (ni.measurements.data.v1.data_store_pb2.PublishedCondition | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PUBLISHED_CONDITION_FIELD_NUMBER: int

property published_condition: ni.measurements.data.v1.data_store_pb2.PublishedCondition

The condition associated with the given id.

Return type:: ni.measurements.data.v1.data_store_pb2.PublishedCondition

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___GetConditionResponse

class ni.measurements.data.v1.data_store_service_pb2.QueryConditionsRequest(*, odata_query=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: odata_query (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ODATA_QUERY_FIELD_NUMBER: int

odata_query: str: an OData query string. example “$filter=name eq ‘Value’” An empty string will return all conditions. $expand, $count, and $select are not supported. For more information, see https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryConditionsRequest

class ni.measurements.data.v1.data_store_service_pb2.QueryConditionsResponse(*, published_conditions=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: published_conditions (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.PublishedCondition] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PUBLISHED_CONDITIONS_FIELD_NUMBER: int

property published_conditions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.PublishedCondition]

The list of matching conditions. Each item contains a moniker for retrieving the condition measurements, as well as the metadata associated with the condition.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.PublishedCondition]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryConditionsResponse

class ni.measurements.data.v1.data_store_service_pb2.QueryMeasurementsRequest(*, odata_query=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: odata_query (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ODATA_QUERY_FIELD_NUMBER: int

odata_query: str: an OData query string. example “$filter=name eq ‘Value’” An empty string will return all measurements. $expand, $count, and $select are not supported. For more information, see https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryMeasurementsRequest

class ni.measurements.data.v1.data_store_service_pb2.QueryMeasurementsResponse(*, published_measurements=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: published_measurements (collections.abc.Iterable[ni.measurements.data.v1.data_store_pb2.PublishedMeasurement] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PUBLISHED_MEASUREMENTS_FIELD_NUMBER: int

property published_measurements: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.PublishedMeasurement]

The list of matching measurements. Each item contains a moniker for retrieving the measurement, as well as the metadata associated with the measurement.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[ni.measurements.data.v1.data_store_pb2.PublishedMeasurement]

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___QueryMeasurementsResponse

class ni.measurements.data.v1.data_store_service_pb2.ReadConditionValueRequest(*, condition_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: condition_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CONDITION_ID_FIELD_NUMBER: int

condition_id: str: The id of the condition to read.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___ReadConditionValueRequest

class ni.measurements.data.v1.data_store_service_pb2.ReadConditionValueResponse(*, vector=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: vector (ni.protobuf.types.vector_pb2.Vector | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VECTOR_FIELD_NUMBER: int

property vector: ni.protobuf.types.vector_pb2.Vector

Return type:: ni.protobuf.types.vector_pb2.Vector

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___ReadConditionValueResponse

class ni.measurements.data.v1.data_store_service_pb2.ReadMeasurementValueRequest(*, measurement_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: measurement_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MEASUREMENT_ID_FIELD_NUMBER: int

measurement_id: str: The id of the measurement to read.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ni.measurements.data.v1.data_store_service_pb2.global___ReadMeasurementValueRequest

class ni.measurements.data.v1.data_store_service_pb2.ReadMeasurementValueResponse(*, vector=..., double_analog_waveform=..., x_y_data=..., i16_analog_waveform=..., double_complex_waveform=..., i16_complex_waveform=..., double_spectrum=..., digital_waveform=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

vector (ni.protobuf.types.vector_pb2.Vector | None)
double_analog_waveform (ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform | None)
x_y_data (ni.protobuf.types.xydata_pb2.DoubleXYData | None)
i16_analog_waveform (ni.protobuf.types.waveform_pb2.I16AnalogWaveform | None)
double_complex_waveform (ni.protobuf.types.waveform_pb2.DoubleComplexWaveform | None)
i16_complex_waveform (ni.protobuf.types.waveform_pb2.I16ComplexWaveform | None)
double_spectrum (ni.protobuf.types.waveform_pb2.DoubleSpectrum | None)
digital_waveform (ni.protobuf.types.waveform_pb2.DigitalWaveform | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VECTOR_FIELD_NUMBER: int

DOUBLE_ANALOG_WAVEFORM_FIELD_NUMBER: int

X_Y_DATA_FIELD_NUMBER: int

I16_ANALOG_WAVEFORM_FIELD_NUMBER: int

DOUBLE_COMPLEX_WAVEFORM_FIELD_NUMBER: int

I16_COMPLEX_WAVEFORM_FIELD_NUMBER: int

DOUBLE_SPECTRUM_FIELD_NUMBER: int

DIGITAL_WAVEFORM_FIELD_NUMBER: int

property vector: ni.protobuf.types.vector_pb2.Vector

Return type:: ni.protobuf.types.vector_pb2.Vector

property double_analog_waveform: ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform

Return type:: ni.protobuf.types.waveform_pb2.DoubleAnalogWaveform

property x_y_data: ni.protobuf.types.xydata_pb2.DoubleXYData

Return type:: ni.protobuf.types.xydata_pb2.DoubleXYData

property i16_analog_waveform: ni.protobuf.types.waveform_pb2.I16AnalogWaveform

Return type:: ni.protobuf.types.waveform_pb2.I16AnalogWaveform

property double_complex_waveform: ni.protobuf.types.waveform_pb2.DoubleComplexWaveform

Return type:: ni.protobuf.types.waveform_pb2.DoubleComplexWaveform

property i16_complex_waveform: ni.protobuf.types.waveform_pb2.I16ComplexWaveform

Return type:: ni.protobuf.types.waveform_pb2.I16ComplexWaveform

property double_spectrum: ni.protobuf.types.waveform_pb2.DoubleSpectrum

Return type:: ni.protobuf.types.waveform_pb2.DoubleSpectrum

property digital_waveform: ni.protobuf.types.waveform_pb2.DigitalWaveform

Return type:: ni.protobuf.types.waveform_pb2.DigitalWaveform

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ni.measurements.data.v1.data_store_service_pb2.global___ReadMeasurementValueResponse