ni.measurements.metadata.v1.metadata_store_pb2

Attributes

DESCRIPTOR

ALIAS_TARGET_TYPE_UNSPECIFIED

ALIAS_TARGET_TYPE_UUT_INSTANCE

ALIAS_TARGET_TYPE_UUT

ALIAS_TARGET_TYPE_HARDWARE_ITEM

ALIAS_TARGET_TYPE_SOFTWARE_ITEM

ALIAS_TARGET_TYPE_OPERATOR

ALIAS_TARGET_TYPE_TEST_DESCRIPTION

ALIAS_TARGET_TYPE_TEST

ALIAS_TARGET_TYPE_TEST_STATION

ALIAS_TARGET_TYPE_TEST_ADAPTER

global___AliasTargetType

global___UutInstance

global___Uut

global___HardwareItem

global___TestAdapter

global___SoftwareItem

global___Operator

global___TestDescription

global___Test

global___TestStation

global___ExtensionValue

global___ExtensionSchema

global___Alias

Classes

AliasTargetType

The type of the aliased metadata instance.

UutInstance

Represents the metadata of a UUT instance

Uut

Represents the metadata of a UUT

HardwareItem

Represents the metadata of a hardware item used to take given measurements

TestAdapter

Represents a test adapter or mechanical setup. This is a board or device

SoftwareItem

Represents the metadata of the software item that was used to take measurements.

Operator

Represents the metadata of the operator that took the test step.

TestDescription

Represents the metadata of a test description

Test

Represents the metadata of a test

TestStation

Represents the metadata of a test station

ExtensionValue

Represents the value of an extension field.

ExtensionSchema

A message that represents an extension schema stored on this system.

Alias

Abstract base class for protocol messages.

Package Contents

ni.measurements.metadata.v1.metadata_store_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class ni.measurements.metadata.v1.metadata_store_pb2.AliasTargetType

Bases: _AliasTargetType

The type of the aliased metadata instance.

ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UNSPECIFIED: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UUT_INSTANCE: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_UUT: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_HARDWARE_ITEM: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_SOFTWARE_ITEM: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_OPERATOR: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_DESCRIPTION: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_STATION: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.ALIAS_TARGET_TYPE_TEST_ADAPTER: AliasTargetType
ni.measurements.metadata.v1.metadata_store_pb2.global___AliasTargetType
class ni.measurements.metadata.v1.metadata_store_pb2.UutInstance(*, id=..., uut_id=..., serial_number=..., manufacture_date=..., firmware_version=..., hardware_version=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a UUT instance

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: global___ExtensionValue
Return type:

global___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_ID_FIELD_NUMBER: int
SERIAL_NUMBER_FIELD_NUMBER: int
MANUFACTURE_DATE_FIELD_NUMBER: int
FIRMWARE_VERSION_FIELD_NUMBER: int
HARDWARE_VERSION_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

uut_id: 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.

serial_number: str

The serial number of the UUT instance

manufacture_date: str

The date the UUT instance was manufactured

firmware_version: str

Version of the firmware on the UUT instance

hardware_version: str

Hardware version of the UUT instance

A link to a resource that describes the UUT instance. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___UutInstance
class ni.measurements.metadata.v1.metadata_store_pb2.Uut(*, id=..., model_name=..., family=..., manufacturers=..., part_number=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a UUT

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: global___ExtensionValue
Return type:

global___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
MODEL_NAME_FIELD_NUMBER: int
FAMILY_FIELD_NUMBER: int
MANUFACTURERS_FIELD_NUMBER: int
PART_NUMBER_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

model_name: str

The name of the UUT model

family: str

The UUT family

part_number: str

The part number of the UUT

A link to a resource that describes the UUT. 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 manufacturers: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

List of manufacturers of the UUT

Return type:

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

property extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___Uut
class ni.measurements.metadata.v1.metadata_store_pb2.HardwareItem(*, id=..., manufacturer=..., model=..., serial_number=..., part_number=..., asset_identifier=..., calibration_due_date=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a hardware item used to take given measurements

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: global___ExtensionValue
Return type:

global___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
MANUFACTURER_FIELD_NUMBER: int
MODEL_FIELD_NUMBER: int
SERIAL_NUMBER_FIELD_NUMBER: int
PART_NUMBER_FIELD_NUMBER: int
ASSET_IDENTIFIER_FIELD_NUMBER: int
CALIBRATION_DUE_DATE_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

manufacturer: str

The manufacturer or vendor of the hardware item

model: str

The name of the hardware item

serial_number: str

The serial number of the hardware item

part_number: str

The part number of the hardware item

asset_identifier: str

The asset identifier for tracking and inventory purposes

calibration_due_date: str

The date when calibration is due for the hardware item

A link to a resource that describes the hardware item. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___HardwareItem
class ni.measurements.metadata.v1.metadata_store_pb2.TestAdapter(*, id=..., name=..., manufacturer=..., model=..., serial_number=..., part_number=..., asset_identifier=..., calibration_due_date=..., link=..., extension=..., schema_id=...)

Bases: 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.

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: global___ExtensionValue
Return type:

global___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
NAME_FIELD_NUMBER: int
MANUFACTURER_FIELD_NUMBER: int
MODEL_FIELD_NUMBER: int
SERIAL_NUMBER_FIELD_NUMBER: int
PART_NUMBER_FIELD_NUMBER: int
ASSET_IDENTIFIER_FIELD_NUMBER: int
CALIBRATION_DUE_DATE_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

name: str

The name or label for the test adapter

manufacturer: str

The manufacturer or vendor of the test adapter

model: str

The model number or name of the test adapter

serial_number: str

The serial number of the test adapter

part_number: str

The part number of the test adapter

asset_identifier: str

The asset identifier for tracking and inventory purposes

calibration_due_date: str

The date when calibration is due for the test adapter

A link to a resource that describes the test adapter. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___TestAdapter
class ni.measurements.metadata.v1.metadata_store_pb2.SoftwareItem(*, id=..., product=..., version=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of the software item that was used to take measurements.

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: global___ExtensionValue
Return type:

global___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
PRODUCT_FIELD_NUMBER: int
VERSION_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

product: str

The product name of the software item

version: str

The version of the software item

A link to a resource that describes the software item. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___SoftwareItem
class ni.measurements.metadata.v1.metadata_store_pb2.Operator(*, id=..., name=..., role=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of the operator that took the test step.

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: global___ExtensionValue
Return type:

global___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
NAME_FIELD_NUMBER: int
ROLE_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

name: str

The name of the operator

role: str

The role of the operator

A link to a resource that describes the operator. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___Operator
class ni.measurements.metadata.v1.metadata_store_pb2.TestDescription(*, id=..., uut_id=..., name=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a test description

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: global___ExtensionValue
Return type:

global___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_ID_FIELD_NUMBER: int
NAME_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

uut_id: str

The id of the UUT this test is designed for

name: str

The name of the test description

A link to a resource that describes the test description. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___TestDescription
class ni.measurements.metadata.v1.metadata_store_pb2.Test(*, id=..., name=..., description=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a test

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: global___ExtensionValue
Return type:

global___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
NAME_FIELD_NUMBER: int
DESCRIPTION_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

name: str

The name of the test

description: str

Explanation of what the test does

A link to a resource that describes the test. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___Test
class ni.measurements.metadata.v1.metadata_store_pb2.TestStation(*, id=..., name=..., asset_identifier=..., link=..., extension=..., schema_id=...)

Bases: google.protobuf.message.Message

Represents the metadata of a test station

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: global___ExtensionValue
Return type:

global___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
NAME_FIELD_NUMBER: int
ASSET_IDENTIFIER_FIELD_NUMBER: int
EXTENSION_FIELD_NUMBER: int
SCHEMA_ID_FIELD_NUMBER: int
id: 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.

name: str

The name of the test station

asset_identifier: str

The asset identifier for tracking and inventory purposes

A link to a resource that describes the test station. 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 extension: 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.

Return type:

google.protobuf.internal.containers.MessageMap[str, global___ExtensionValue]

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.metadata.v1.metadata_store_pb2.global___TestStation
class ni.measurements.metadata.v1.metadata_store_pb2.ExtensionValue(*, string_value=...)

Bases: google.protobuf.message.Message

Represents the value of an extension field. Currently, only string values are supported.

Parameters:

string_value (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor
STRING_VALUE_FIELD_NUMBER: int
string_value: str

The string value of the extension field.

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.metadata.v1.metadata_store_pb2.global___ExtensionValue
class ni.measurements.metadata.v1.metadata_store_pb2.ExtensionSchema(*, id=..., schema=...)

Bases: google.protobuf.message.Message

A message that represents an extension schema stored on this system.

Parameters:
DESCRIPTOR: google.protobuf.descriptor.Descriptor
ID_FIELD_NUMBER: int
SCHEMA_FIELD_NUMBER: int
id: str

The id of the schema.

schema: str

The schema itself.

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.metadata.v1.metadata_store_pb2.global___ExtensionSchema
class ni.measurements.metadata.v1.metadata_store_pb2.Alias(*, name=..., target_type=..., target_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
NAME_FIELD_NUMBER: int
TARGET_TYPE_FIELD_NUMBER: int
TARGET_ID_FIELD_NUMBER: int
name: str

The registered alias name for the aliased metadata instance.

target_type: global___AliasTargetType

The type of the aliased metadata instance.

target_id: str

The unique identifier for the aliased metadata instance.

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.metadata.v1.metadata_store_pb2.global___Alias