ni.measurements.metadata.v1.metadata_store_pb2 ============================================== .. py:module:: ni.measurements.metadata.v1.metadata_store_pb2 Attributes ---------- .. autoapisummary:: ni.measurements.metadata.v1.metadata_store_pb2.DESCRIPTOR ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UNSPECIFIED ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UUT_INSTANCE ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UUT ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_HARDWARE_ITEM ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_SOFTWARE_ITEM ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_OPERATOR ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_DESCRIPTION ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_STATION ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_ADAPTER ni.measurements.metadata.v1.metadata_store_pb2.global___AliasTargetType ni.measurements.metadata.v1.metadata_store_pb2.global___UutInstance ni.measurements.metadata.v1.metadata_store_pb2.global___Uut ni.measurements.metadata.v1.metadata_store_pb2.global___HardwareItem ni.measurements.metadata.v1.metadata_store_pb2.global___TestAdapter ni.measurements.metadata.v1.metadata_store_pb2.global___SoftwareItem ni.measurements.metadata.v1.metadata_store_pb2.global___Operator ni.measurements.metadata.v1.metadata_store_pb2.global___TestDescription ni.measurements.metadata.v1.metadata_store_pb2.global___Test ni.measurements.metadata.v1.metadata_store_pb2.global___TestStation ni.measurements.metadata.v1.metadata_store_pb2.global___ExtensionValue ni.measurements.metadata.v1.metadata_store_pb2.global___ExtensionSchema ni.measurements.metadata.v1.metadata_store_pb2.global___Alias Classes ------- .. autoapisummary:: ni.measurements.metadata.v1.metadata_store_pb2.AliasTargetType ni.measurements.metadata.v1.metadata_store_pb2.UutInstance ni.measurements.metadata.v1.metadata_store_pb2.Uut ni.measurements.metadata.v1.metadata_store_pb2.HardwareItem ni.measurements.metadata.v1.metadata_store_pb2.TestAdapter ni.measurements.metadata.v1.metadata_store_pb2.SoftwareItem ni.measurements.metadata.v1.metadata_store_pb2.Operator ni.measurements.metadata.v1.metadata_store_pb2.TestDescription ni.measurements.metadata.v1.metadata_store_pb2.Test ni.measurements.metadata.v1.metadata_store_pb2.TestStation ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue ni.measurements.metadata.v1.metadata_store_pb2.ExtensionSchema ni.measurements.metadata.v1.metadata_store_pb2.Alias Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: AliasTargetType Bases: :py:obj:`_AliasTargetType` The type of the aliased metadata instance. .. py:data:: ALIAS_TARGET_TYPE_UNSPECIFIED :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_UUT_INSTANCE :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_UUT :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_HARDWARE_ITEM :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_SOFTWARE_ITEM :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_OPERATOR :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_TEST_DESCRIPTION :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_TEST :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_TEST_STATION :type: AliasTargetType .. py:data:: ALIAS_TARGET_TYPE_TEST_ADAPTER :type: AliasTargetType .. py:data:: global___AliasTargetType .. py:class:: UutInstance(*, id = ..., uut_id = ..., serial_number = ..., manufacture_date = ..., firmware_version = ..., hardware_version = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a UUT instance .. 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: global___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_ID_FIELD_NUMBER :type: int .. py:attribute:: SERIAL_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: MANUFACTURE_DATE_FIELD_NUMBER :type: int .. py:attribute:: FIRMWARE_VERSION_FIELD_NUMBER :type: int .. py:attribute:: HARDWARE_VERSION_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 UUT instance This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: uut_id :type: str The id of the UUT associated with this UUT instance. 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:: serial_number :type: str The serial number of the UUT instance .. py:attribute:: manufacture_date :type: str The date the UUT instance was manufactured .. py:attribute:: firmware_version :type: str Version of the firmware on the UUT instance .. py:attribute:: hardware_version :type: str Hardware version of the UUT instance .. py:attribute:: link :type: str A link to a resource that describes the UUT instance. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your UutInstance 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:: 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___UutInstance .. py:class:: Uut(*, id = ..., model_name = ..., family = ..., manufacturers = ..., part_number = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a UUT .. 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: global___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:: MODEL_NAME_FIELD_NUMBER :type: int .. py:attribute:: FAMILY_FIELD_NUMBER :type: int .. py:attribute:: MANUFACTURERS_FIELD_NUMBER :type: int .. py:attribute:: PART_NUMBER_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 UUT This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: model_name :type: str The name of the UUT model .. py:attribute:: family :type: str The UUT family .. py:attribute:: part_number :type: str The part number of the UUT .. py:attribute:: link :type: str A link to a resource that describes the UUT. 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:: manufacturers :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] List of manufacturers of the UUT .. py:property:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your Uut 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:: 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___Uut .. py:class:: HardwareItem(*, id = ..., manufacturer = ..., model = ..., serial_number = ..., part_number = ..., asset_identifier = ..., calibration_due_date = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a hardware item used to take given measurements .. 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: global___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:: MANUFACTURER_FIELD_NUMBER :type: int .. py:attribute:: MODEL_FIELD_NUMBER :type: int .. py:attribute:: SERIAL_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: PART_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: ASSET_IDENTIFIER_FIELD_NUMBER :type: int .. py:attribute:: CALIBRATION_DUE_DATE_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 hardware item This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: manufacturer :type: str The manufacturer or vendor of the hardware item .. py:attribute:: model :type: str The name of the hardware item .. py:attribute:: serial_number :type: str The serial number of the hardware item .. py:attribute:: part_number :type: str The part number of the hardware item .. py:attribute:: asset_identifier :type: str The asset identifier for tracking and inventory purposes .. py:attribute:: calibration_due_date :type: str The date when calibration is due for the hardware item .. py:attribute:: link :type: str A link to a resource that describes the hardware item. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your HardwareItem 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:: 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___HardwareItem .. py:class:: TestAdapter(*, id = ..., name = ..., manufacturer = ..., model = ..., serial_number = ..., part_number = ..., asset_identifier = ..., calibration_due_date = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents a test adapter or mechanical setup. This is a board or device that is used to hold, connect, or interface the UUT with the test system. Test adapters may also be referred to as test fixtures, interface boards, breakout boxes, mechanical fixtures, or connection adapters. .. 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: global___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:: NAME_FIELD_NUMBER :type: int .. py:attribute:: MANUFACTURER_FIELD_NUMBER :type: int .. py:attribute:: MODEL_FIELD_NUMBER :type: int .. py:attribute:: SERIAL_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: PART_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: ASSET_IDENTIFIER_FIELD_NUMBER :type: int .. py:attribute:: CALIBRATION_DUE_DATE_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 test adapter This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: name :type: str The name or label for the test adapter .. py:attribute:: manufacturer :type: str The manufacturer or vendor of the test adapter .. py:attribute:: model :type: str The model number or name of the test adapter .. py:attribute:: serial_number :type: str The serial number of the test adapter .. py:attribute:: part_number :type: str The part number of the test adapter .. py:attribute:: asset_identifier :type: str The asset identifier for tracking and inventory purposes .. py:attribute:: calibration_due_date :type: str The date when calibration is due for the test adapter .. py:attribute:: link :type: str A link to a resource that describes the test adapter. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your TestAdapter 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:: 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___TestAdapter .. py:class:: SoftwareItem(*, id = ..., product = ..., version = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of the software item that was used to take measurements. .. 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: global___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:: PRODUCT_FIELD_NUMBER :type: int .. py:attribute:: VERSION_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 software item This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: product :type: str The product name of the software item .. py:attribute:: version :type: str The version of the software item .. py:attribute:: link :type: str A link to a resource that describes the software item. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your SoftwareItem 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:: 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___SoftwareItem .. py:class:: Operator(*, id = ..., name = ..., role = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of the operator that took the test step. .. 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: global___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:: NAME_FIELD_NUMBER :type: int .. py:attribute:: ROLE_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 operator This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: name :type: str The name of the operator .. py:attribute:: role :type: str The role of the operator .. py:attribute:: link :type: str A link to a resource that describes the operator. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your Operator 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:: 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___Operator .. py:class:: TestDescription(*, id = ..., uut_id = ..., name = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a test description .. 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: global___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_ID_FIELD_NUMBER :type: int .. py:attribute:: NAME_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 test description This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: uut_id :type: str The id of the UUT this test is designed for .. py:attribute:: name :type: str The name of the test description .. py:attribute:: link :type: str A link to a resource that describes the test description. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your TestDescription 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:: 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___TestDescription .. py:class:: Test(*, id = ..., name = ..., description = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a test .. 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: global___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:: NAME_FIELD_NUMBER :type: int .. py:attribute:: DESCRIPTION_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 test This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: name :type: str The name of the test .. py:attribute:: description :type: str Explanation of what the test does .. py:attribute:: link :type: str A link to a resource that describes the test. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your Test 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:: 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___Test .. py:class:: TestStation(*, id = ..., name = ..., asset_identifier = ..., link = ..., extension = ..., schema_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the metadata of a test station .. 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: global___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:: NAME_FIELD_NUMBER :type: int .. py:attribute:: ASSET_IDENTIFIER_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 test station This value is a string representation of a GUID. It is generated by the metadata store and cannot be set/specified by clients. .. py:attribute:: name :type: str The name of the test station .. py:attribute:: asset_identifier :type: str The asset identifier for tracking and inventory purposes .. py:attribute:: link :type: str A link to a resource that describes the test station. 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:: extension :type: google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue] Optional. Any attributes used to extend the definition of your TestStation 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:: 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___TestStation .. py:class:: ExtensionValue(*, string_value = ...) Bases: :py:obj:`google.protobuf.message.Message` Represents the value of an extension field. Currently, only string values are supported. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: STRING_VALUE_FIELD_NUMBER :type: int .. py:attribute:: string_value :type: str The string value of the extension 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:method:: WhichOneof(oneof_group) Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___ExtensionValue .. py:class:: ExtensionSchema(*, id = ..., schema = ...) Bases: :py:obj:`google.protobuf.message.Message` A message that represents an extension schema stored on this system. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: SCHEMA_FIELD_NUMBER :type: int .. py:attribute:: id :type: str The id of the schema. .. py:attribute:: schema :type: str The schema itself. .. 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___ExtensionSchema .. py:class:: Alias(*, name = ..., target_type = ..., target_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:: NAME_FIELD_NUMBER :type: int .. py:attribute:: TARGET_TYPE_FIELD_NUMBER :type: int .. py:attribute:: TARGET_ID_FIELD_NUMBER :type: int .. py:attribute:: name :type: str The registered alias name for the aliased metadata instance. .. py:attribute:: target_type :type: global___AliasTargetType The type of the aliased metadata instance. .. py:attribute:: target_id :type: str The unique identifier for the aliased metadata instance. .. 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___Alias