ni.measurements.data.v1.data_store_pb2 ====================================== .. py:module:: ni.measurements.data.v1.data_store_pb2 Attributes ---------- .. autoapisummary:: ni.measurements.data.v1.data_store_pb2.DESCRIPTOR ni.measurements.data.v1.data_store_pb2.OUTCOME_UNSPECIFIED ni.measurements.data.v1.data_store_pb2.OUTCOME_PASSED ni.measurements.data.v1.data_store_pb2.OUTCOME_FAILED ni.measurements.data.v1.data_store_pb2.OUTCOME_INDETERMINATE ni.measurements.data.v1.data_store_pb2.global___Outcome ni.measurements.data.v1.data_store_pb2.global___PublishedCondition ni.measurements.data.v1.data_store_pb2.global___PublishedMeasurement ni.measurements.data.v1.data_store_pb2.global___TestResult ni.measurements.data.v1.data_store_pb2.global___Step ni.measurements.data.v1.data_store_pb2.global___ErrorInformation Classes ------- .. autoapisummary:: ni.measurements.data.v1.data_store_pb2.Outcome ni.measurements.data.v1.data_store_pb2.PublishedCondition ni.measurements.data.v1.data_store_pb2.PublishedMeasurement ni.measurements.data.v1.data_store_pb2.TestResult ni.measurements.data.v1.data_store_pb2.Step ni.measurements.data.v1.data_store_pb2.ErrorInformation Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: Outcome Bases: :py:obj:`_Outcome` Describes the outcome of a measurement .. py:data:: OUTCOME_UNSPECIFIED :type: Outcome No outcome was specified. .. py:data:: OUTCOME_PASSED :type: Outcome The measurement passed. .. py:data:: OUTCOME_FAILED :type: Outcome The measurement failed. .. py:data:: OUTCOME_INDETERMINATE :type: Outcome The outcome is indeterminate. .. py:data:: global___Outcome .. py:class:: PublishedCondition(*, moniker = ..., id = ..., name = ..., condition_type = ..., step_id = ..., test_result_id = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: MONIKER_FIELD_NUMBER :type: int .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: CONDITION_TYPE_FIELD_NUMBER :type: int .. py:attribute:: STEP_ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_RESULT_ID_FIELD_NUMBER :type: int .. py:attribute:: id :type: str The unique identifier of the condition. This can be used to reference and find the condition in the data store. .. py:attribute:: name :type: str The name of the condition. .. py:attribute:: condition_type :type: str The type of the condition. For example, "Setup" or "Environment". .. py:attribute:: step_id :type: str The id of the step with which this condition is associated. .. py:attribute:: test_result_id :type: str The id of the test result with which this condition is associated. .. py:property:: moniker :type: 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 .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PublishedCondition .. py:class:: 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: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: MONIKER_FIELD_NUMBER :type: int .. py:attribute:: PUBLISHED_CONDITIONS_FIELD_NUMBER :type: int .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_RESULT_ID_FIELD_NUMBER :type: int .. py:attribute:: STEP_ID_FIELD_NUMBER :type: int .. py:attribute:: SOFTWARE_ITEM_IDS_FIELD_NUMBER :type: int .. py:attribute:: HARDWARE_ITEM_IDS_FIELD_NUMBER :type: int .. py:attribute:: TEST_ADAPTER_IDS_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: VALUE_TYPE_FIELD_NUMBER :type: int .. py:attribute:: NOTES_FIELD_NUMBER :type: int .. py:attribute:: START_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: END_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: OUTCOME_FIELD_NUMBER :type: int .. py:attribute:: PARAMETRIC_INDEX_FIELD_NUMBER :type: int .. py:attribute:: ERROR_INFORMATION_FIELD_NUMBER :type: int .. py:attribute:: id :type: str The id of the measurement. .. py:attribute:: test_result_id :type: str The id of the test result with which this measurement is associated. .. py:attribute:: step_id :type: str The id of the step with which this measurement is associated. .. py:attribute:: name :type: str The name used to group measurements across multiple publishes. .. py:attribute:: value_type :type: str The type of the value of the measurement. This is used to filter measurements in queries. .. py:attribute:: notes :type: str Any notes about the measurement. .. py:attribute:: outcome :type: global___Outcome The most 'significant' outcome that was observed when publishing to this measurement. Significance hierarchy: Unspecified (default) < Passed < Indeterminate < Failed .. py:attribute:: parametric_index :type: int The index within a parametric set, or -1 if this represents the entire set. .. py:property:: moniker :type: 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. .. py:property:: published_conditions :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PublishedCondition] The conditions associated with the test step that owns this measurement. .. py:property:: software_item_ids :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] The ids of the software items with which this measurement is associated. .. py:property:: hardware_item_ids :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] The ids of the hardware items with which this measurement is associated. .. py:property:: test_adapter_ids :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] The ids of the test adapters with which this measurement is associated. .. py:property:: start_date_time :type: 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. .. py:property:: end_date_time :type: 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. .. py:property:: error_information :type: 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. .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PublishedMeasurement .. py:class:: 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: :py:obj:`google.protobuf.message.Message` The information about the test result with which a test step is associated. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:class:: ExtensionEntry(*, key = ..., value = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: KEY_FIELD_NUMBER :type: int .. py:attribute:: VALUE_FIELD_NUMBER :type: int .. py:attribute:: key :type: str .. py:property:: value :type: ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: UUT_INSTANCE_ID_FIELD_NUMBER :type: int .. py:attribute:: OPERATOR_ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_STATION_ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_DESCRIPTION_ID_FIELD_NUMBER :type: int .. py:attribute:: SOFTWARE_ITEM_IDS_FIELD_NUMBER :type: int .. py:attribute:: HARDWARE_ITEM_IDS_FIELD_NUMBER :type: int .. py:attribute:: TEST_ADAPTER_IDS_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: START_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: END_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: OUTCOME_FIELD_NUMBER :type: int .. py:attribute:: ERROR_INFORMATION_FIELD_NUMBER :type: int .. py:attribute:: LINK_FIELD_NUMBER :type: int .. py:attribute:: EXTENSION_FIELD_NUMBER :type: int .. py:attribute:: SCHEMA_ID_FIELD_NUMBER :type: int .. py:attribute:: id :type: 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. .. py:attribute:: uut_instance_id :type: 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. .. py:attribute:: operator_id :type: 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. .. py:attribute:: test_station_id :type: 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. .. py:attribute:: test_description_id :type: 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. .. py:attribute:: name :type: str Required. The name of the test result. .. py:attribute:: outcome :type: 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 .. py:attribute:: link :type: str Optional. A link to a resource that describes the test result. This value is expected to be a valid URI. .. py:attribute:: schema_id :type: 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. .. py:property:: software_item_ids :type: 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. .. py:property:: hardware_item_ids :type: 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. .. py:property:: test_adapter_ids :type: 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. .. py:property:: start_date_time :type: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp Optional. Start date and time of the test execution (timestamp) .. py:property:: end_date_time :type: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp Optional. End date and time of the test execution (timestamp) .. py:property:: error_information :type: 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. .. py:property:: extension :type: 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. .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___TestResult .. py:class:: 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: :py:obj:`google.protobuf.message.Message` Represents the metadata of the step that was taken .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:class:: ExtensionEntry(*, key = ..., value = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: KEY_FIELD_NUMBER :type: int .. py:attribute:: VALUE_FIELD_NUMBER :type: int .. py:attribute:: key :type: str .. py:property:: value :type: ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: PARENT_STEP_ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_RESULT_ID_FIELD_NUMBER :type: int .. py:attribute:: TEST_ID_FIELD_NUMBER :type: int .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: STEP_TYPE_FIELD_NUMBER :type: int .. py:attribute:: NOTES_FIELD_NUMBER :type: int .. py:attribute:: START_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: END_DATE_TIME_FIELD_NUMBER :type: int .. py:attribute:: OUTCOME_FIELD_NUMBER :type: int .. py:attribute:: ERROR_INFORMATION_FIELD_NUMBER :type: int .. py:attribute:: LINK_FIELD_NUMBER :type: int .. py:attribute:: EXTENSION_FIELD_NUMBER :type: int .. py:attribute:: SCHEMA_ID_FIELD_NUMBER :type: int .. py:attribute:: id :type: str The unique identifier of the step This value should be a string representation of a UUID. .. py:attribute:: parent_step_id :type: str The parent step identifier .. py:attribute:: test_result_id :type: 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. .. py:attribute:: test_id :type: 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. .. py:attribute:: name :type: str Required. The name of the step. .. py:attribute:: step_type :type: str Step type (e.g., Setup, Action, Measurement, Cleanup) .. py:attribute:: notes :type: str Any notes about the step .. py:attribute:: outcome :type: 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 .. py:attribute:: link :type: str A link to a resource that describes the step. This value is expected to be a valid URI. .. py:attribute:: schema_id :type: 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. .. py:property:: start_date_time :type: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp Start date and time of the test step (timestamp) .. py:property:: end_date_time :type: ni.protobuf.types.precision_timestamp_pb2.PrecisionTimestamp End date and time of the test step (timestamp) .. py:property:: error_information :type: 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. .. py:property:: extension :type: 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. .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___Step .. py:class:: ErrorInformation(*, error_code = ..., message = ..., source = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents an error message resulting from a failed operation .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: ERROR_CODE_FIELD_NUMBER :type: int .. py:attribute:: MESSAGE_FIELD_NUMBER :type: int .. py:attribute:: SOURCE_FIELD_NUMBER :type: int .. py:attribute:: error_code :type: int The error code associated with the error .. py:attribute:: message :type: str The error message associated with the error .. py:attribute:: source :type: str Information about the source of the error. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ErrorInformation