ni.measurements.data.v1.data_store_pb2

Attributes

DESCRIPTOR

OUTCOME_UNSPECIFIED

No outcome was specified.

OUTCOME_PASSED

The measurement passed.

OUTCOME_FAILED

The measurement failed.

OUTCOME_INDETERMINATE

The outcome is indeterminate.

global___Outcome

global___PublishedCondition

global___PublishedMeasurement

global___TestResult

global___Step

global___ErrorInformation

Classes

Outcome

Describes the outcome of a measurement

PublishedCondition

Abstract base class for protocol messages.

PublishedMeasurement

Abstract base class for protocol messages.

TestResult

The information about the test result with which a test step is associated.

Step

Represents the metadata of the step that was taken

ErrorInformation

Represents an error message resulting from a failed operation

Package Contents

ni.measurements.data.v1.data_store_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class ni.measurements.data.v1.data_store_pb2.Outcome

Bases: _Outcome

Describes the outcome of a measurement

ni.measurements.data.v1.data_store_pb2.OUTCOME_UNSPECIFIED: Outcome

No outcome was specified.

ni.measurements.data.v1.data_store_pb2.OUTCOME_PASSED: Outcome

The measurement passed.

ni.measurements.data.v1.data_store_pb2.OUTCOME_FAILED: Outcome

The measurement failed.

ni.measurements.data.v1.data_store_pb2.OUTCOME_INDETERMINATE: Outcome

The outcome is indeterminate.

ni.measurements.data.v1.data_store_pb2.global___Outcome
class ni.measurements.data.v1.data_store_pb2.PublishedCondition(*, moniker=..., id=..., name=..., condition_type=..., step_id=..., 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:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
MONIKER_FIELD_NUMBER: int
ID_FIELD_NUMBER: int
NAME_FIELD_NUMBER: int
CONDITION_TYPE_FIELD_NUMBER: int
STEP_ID_FIELD_NUMBER: int
TEST_RESULT_ID_FIELD_NUMBER: int
id: str

The unique identifier of the condition. This can be used to reference and find the condition in the data store.

name: str

The name of the condition.

condition_type: str

The type of the condition. For example, “Setup” or “Environment”.

step_id: str

The id of the step with which this condition is associated.

test_result_id: str

The id of the test result with which this condition is associated.

property moniker: ni.datamonikers.v1.data_moniker_pb2.Moniker

The moniker of the condition that this value is associated with. This moniker returns a ni.protobuf.types.Vector

Return type:

ni.datamonikers.v1.data_moniker_pb2.Moniker

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_pb2.global___PublishedCondition
class ni.measurements.data.v1.data_store_pb2.PublishedMeasurement(*, moniker=..., published_conditions=..., id=..., test_result_id=..., step_id=..., software_item_ids=..., hardware_item_ids=..., test_adapter_ids=..., name=..., value_type=..., notes=..., start_date_time=..., end_date_time=..., outcome=..., parametric_index=..., error_information=...)

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:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
MONIKER_FIELD_NUMBER: int
PUBLISHED_CONDITIONS_FIELD_NUMBER: int
ID_FIELD_NUMBER: int
TEST_RESULT_ID_FIELD_NUMBER: int
STEP_ID_FIELD_NUMBER: int
SOFTWARE_ITEM_IDS_FIELD_NUMBER: int
HARDWARE_ITEM_IDS_FIELD_NUMBER: int
TEST_ADAPTER_IDS_FIELD_NUMBER: int
NAME_FIELD_NUMBER: int
VALUE_TYPE_FIELD_NUMBER: int
NOTES_FIELD_NUMBER: int
START_DATE_TIME_FIELD_NUMBER: int
END_DATE_TIME_FIELD_NUMBER: int
OUTCOME_FIELD_NUMBER: int
PARAMETRIC_INDEX_FIELD_NUMBER: int
ERROR_INFORMATION_FIELD_NUMBER: int
id: str

The id of the measurement.

test_result_id: str

The id of the test result with which this measurement is associated.

step_id: str

The id of the step with which this measurement is associated.

name: str

The name used to group measurements across multiple publishes.

value_type: str

The type of the value of the measurement. This is used to filter measurements in queries.

notes: str

Any notes about the measurement.

outcome: global___Outcome

The most ‘significant’ outcome that was observed when publishing to this measurement. Significance hierarchy: Unspecified (default) < Passed < Indeterminate < Failed

parametric_index: int

The index within a parametric set, or -1 if this represents the entire set.

property moniker: ni.datamonikers.v1.data_moniker_pb2.Moniker

The moniker providing access to measurement data. Scalar measurements are returned as Vectors; other types are returned as published.

Return type:

ni.datamonikers.v1.data_moniker_pb2.Moniker

property published_conditions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PublishedCondition]

The conditions associated with the test step that owns this measurement.

Return type:

google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PublishedCondition]

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

The ids of the software items with which this measurement is associated.

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

The ids of the hardware items with which this measurement is associated.

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

The ids of the test adapters with which this measurement is associated.

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property start_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

The date and time at which the measurement was first published. If the measurement represents a parametric set, this is the timestamp of the first measurement published to the parametric set.

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property end_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

The date and time at which the measurement was last published. If the measurement represents a parametric set, this is the timestamp of the last measurement published to the parametric set.

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property error_information: global___ErrorInformation

Error or exception information in JSON format. If the measurement represents a parametric set, this contains the error information for the first error that occurred when publishing to the parametric set.

Return type:

global___ErrorInformation

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_pb2.global___PublishedMeasurement
class ni.measurements.data.v1.data_store_pb2.TestResult(*, id=..., uut_instance_id=..., operator_id=..., test_station_id=..., test_description_id=..., software_item_ids=..., hardware_item_ids=..., test_adapter_ids=..., name=..., start_date_time=..., end_date_time=..., outcome=..., error_information=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

The information about the test result with which a test step is associated.

Parameters:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
class ExtensionEntry(*, key=..., value=...)

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:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
KEY_FIELD_NUMBER: int
VALUE_FIELD_NUMBER: int
key: str
property value: ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue
Return type:

ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue

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

ID_FIELD_NUMBER: int
UUT_INSTANCE_ID_FIELD_NUMBER: int
OPERATOR_ID_FIELD_NUMBER: int
TEST_STATION_ID_FIELD_NUMBER: int
TEST_DESCRIPTION_ID_FIELD_NUMBER: int
SOFTWARE_ITEM_IDS_FIELD_NUMBER: int
HARDWARE_ITEM_IDS_FIELD_NUMBER: int
TEST_ADAPTER_IDS_FIELD_NUMBER: int
NAME_FIELD_NUMBER: int
START_DATE_TIME_FIELD_NUMBER: int
END_DATE_TIME_FIELD_NUMBER: int
OUTCOME_FIELD_NUMBER: int
ERROR_INFORMATION_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: str

Optional. If you specify an id, the value is expected to be a parsable GUID. If you do not specify an id, one will be generated for you, and returned in the response.

uut_instance_id: str

Optional. The id of the UUT instance associated with this test result. This value is expected to be a parsable GUID or an alias. It will always be returned from the service as a GUID. See ni.measurements.metadata.MetadataStoreService for more information.

operator_id: str

Optional. The id of the operator associated with this test result. This value is expected to be a parsable GUID or an alias. It will always be returned from the service as a GUID. See ni.measurements.metadata.MetadataStoreService for more information.

test_station_id: str

Optional. The id of the test station associated with this test result. This value is expected to be a parsable GUID or an alias. It will always be returned from the service as a GUID. See ni.measurements.metadata.MetadataStoreService for more information.

test_description_id: str

Optional. The id of the test description associated with this test result. This value is expected to be a parsable GUID or an alias. It will always be returned from the service as a GUID. See ni.measurements.metadata.MetadataStoreService for more information.

name: str

Required. The name of the test result.

outcome: global___Outcome

Optional. Overall test result outcome (e.g., Passed, Failed, Indeterminate) The outcome can be set on creation if it is known at the time of creation. Otherwise, the outcome will be calculated based on the outcomes of the associated steps. If the outcome is calculated, the most ‘significant’ outcome is the outcome that will be reported. Significance hierarchy: Unspecified (default) < Passed < Indeterminate < Failed

Optional. A link to a resource that describes the test result. This value is expected to be a valid URI.

schema_id: str

Optional. If any of your messages contain ‘extension’, you must register a schema, and specify the schema id here. In that case, all metadata will be validated against the specified schema.

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

Optional. The ids of the software item associated with this test result. These values are expected to be parsable GUIDs or aliases. They will always be returned from the service as GUIDs.

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

Optional. The ids of the hardware item associated with this test result. These values are expected to be parsable GUIDs or aliases. They will always be returned from the service as GUIDs.

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 test result. These values are expected to be parsable GUIDs or aliases. They will always be returned from the service as GUIDs.

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property start_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

Optional. Start date and time of the test execution (timestamp)

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property end_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

Optional. End date and time of the test execution (timestamp)

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property error_information: global___ErrorInformation

Optional. Any error information associated with the test result. Error information can be set on creation if it is known at the time of creation. Otherwise, the error information will be calculated based on the outcomes of the associated steps. If the error information is calculated, the first observed error information will be reported.

Return type:

global___ErrorInformation

property extension: google.protobuf.internal.containers.MessageMap[str, ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue]

Optional. Any attributes used to extend the definition of your test result can go here. To add extension attributes, you must first register a schema, and specify the schema’s id in the ‘schema_id’ field.

Return type:

google.protobuf.internal.containers.MessageMap[str, ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue]

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_pb2.global___TestResult
class ni.measurements.data.v1.data_store_pb2.Step(*, id=..., parent_step_id=..., test_result_id=..., test_id=..., name=..., step_type=..., notes=..., start_date_time=..., end_date_time=..., outcome=..., error_information=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of the step that was taken

Parameters:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
class ExtensionEntry(*, key=..., value=...)

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:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
KEY_FIELD_NUMBER: int
VALUE_FIELD_NUMBER: int
key: str
property value: ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue
Return type:

ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue

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

ID_FIELD_NUMBER: int
PARENT_STEP_ID_FIELD_NUMBER: int
TEST_RESULT_ID_FIELD_NUMBER: int
TEST_ID_FIELD_NUMBER: int
NAME_FIELD_NUMBER: int
STEP_TYPE_FIELD_NUMBER: int
NOTES_FIELD_NUMBER: int
START_DATE_TIME_FIELD_NUMBER: int
END_DATE_TIME_FIELD_NUMBER: int
OUTCOME_FIELD_NUMBER: int
ERROR_INFORMATION_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: str

The unique identifier of the step This value should be a string representation of a UUID.

parent_step_id: str

The parent step identifier

test_result_id: str

Optional. The id of the test result associated with this test step. If not specified, a test result will be created from the information that can be implicitly obtained.

test_id: str

Optional. The id of the test associated with this test step. This value is expected to be a parsable GUID or an alias. It will always be returned from the service as a GUID. See ni.measurements.metadata.MetadataStoreService for more information.

name: str

Required. The name of the step.

step_type: str

Step type (e.g., Setup, Action, Measurement, Cleanup)

notes: str

Any notes about the step

outcome: global___Outcome

Optional. Overall step outcome (e.g., Passed, Failed, Indeterminate) The outcome can be set on creation if it is known at the time of creation. Otherwise, the outcome will be calculated based on the outcomes of the associated measurements. If the outcome is calculated, the most ‘significant’ outcome is the outcome that will be reported. Significance hierarchy: Unspecified (default) < Passed < Indeterminate < Failed

A link to a resource that describes the step. This value is expected to be a valid URI.

schema_id: str

The unique identifier of the schema that applies to this instance’s extension. If any extension is associated with this instance, a schema_id must be provided.

property start_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

Start date and time of the test step (timestamp)

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property end_date_time: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

End date and time of the test step (timestamp)

Return type:

ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp

property error_information: global___ErrorInformation

Optional. Any error information associated with the test step. Error information can be set on creation if it is known at the time of creation. Otherwise, the error information will be calculated based on the outcomes of the associated measurements. If the error information is calculated, the first observed error information will be reported.

Return type:

global___ErrorInformation

property extension: google.protobuf.internal.containers.MessageMap[str, ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue]

Optional. Any attributes used to extend the definition of your test step can go here. To add extension attributes, you must first register a schema, and specify the schema’s id in the ‘schema_id’ field.

Return type:

google.protobuf.internal.containers.MessageMap[str, ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue]

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_pb2.global___Step
class ni.measurements.data.v1.data_store_pb2.ErrorInformation(*, error_code=..., message=..., source=...)

Bases: google.protobuf.message.Message

Represents an error message resulting from a failed operation

Parameters:

  • error_code (int)

  • message (str)

  • source (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor
ERROR_CODE_FIELD_NUMBER: int
MESSAGE_FIELD_NUMBER: int
SOURCE_FIELD_NUMBER: int
error_code: int

The error code associated with the error

message: str

The error message associated with the error

source: str

Information about the source of the error.

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_pb2.global___ErrorInformation