ni.measurements.metadata.v1.client

Public API for accessing the NI Metadata Store Service.

Classes

MetadataStoreClient

Client for accessing the NI Metadata Store Service.

Package Contents

class ni.measurements.metadata.v1.client.MetadataStoreClient(*, discovery_client=None, grpc_channel=None, grpc_channel_pool=None)[source]

Bases: ni.measurements.metadata.v1.client._client_base.GrpcServiceClientBase[ni.measurements.metadata.v1.metadata_store_service_pb2_grpc.MetadataStoreServiceStub]

Client for accessing the NI Metadata Store Service.

Initialize the Metadata Store Client.

Parameters:

discovery_client (ni.measurementlink.discovery.v1.client.DiscoveryClient | None) – An optional discovery client (recommended).
grpc_channel (grpc.Channel | None) – An optional metadata store gRPC channel.
grpc_channel_pool (ni_grpc_extensions.channelpool.GrpcChannelPool | None) – An optional gRPC channel pool (recommended).

__slots__ = ()

get_uut_instance(request)[source]

Gets the UUT instance associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetUutInstanceRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetUutInstanceResponse

query_uut_instances(request)[source]

Perform an OData query on UUT instances.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryUutInstancesRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryUutInstancesResponse

create_uut_instance(request)[source]

Creates a new UUT instance in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateUutInstanceRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateUutInstanceResponse

get_uut(request)[source]

Gets the UUT associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetUutRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetUutResponse

query_uuts(request)[source]

Perform an OData query on UUTs.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryUutsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryUutsResponse

create_uut(request)[source]

Creates a new UUT in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateUutRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateUutResponse

get_operator(request)[source]

Gets the operator associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetOperatorRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetOperatorResponse

query_operators(request)[source]

Perform an OData query on operators.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryOperatorsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryOperatorsResponse

create_operator(request)[source]

Creates a new operator in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateOperatorRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateOperatorResponse

get_test_description(request)[source]

Gets the test description associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestDescriptionRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestDescriptionResponse

query_test_descriptions(request)[source]

Perform an OData query on test descriptions.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestDescriptionsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestDescriptionsResponse

create_test_description(request)[source]

Creates a new test description in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestDescriptionRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestDescriptionResponse

get_test(request)[source]

Gets the test associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestResponse

query_tests(request)[source]

Perform an OData query on tests.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestsResponse

create_test(request)[source]

Creates a new test in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestResponse

get_test_station(request)[source]

Gets the test station associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestStationRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestStationResponse

query_test_stations(request)[source]

Perform an OData query on test stations.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestStationsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestStationsResponse

create_test_station(request)[source]

Creates a new test station in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestStationRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestStationResponse

get_hardware_item(request)[source]

Gets the hardware item associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetHardwareItemRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetHardwareItemResponse

query_hardware_items(request)[source]

Perform an OData query on hardware items.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryHardwareItemsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryHardwareItemsResponse

create_hardware_item(request)[source]

Creates a new hardware item in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateHardwareItemRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateHardwareItemResponse

get_software_item(request)[source]

Gets the software item associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetSoftwareItemRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetSoftwareItemResponse

query_software_items(request)[source]

Perform an OData query on software items.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QuerySoftwareItemsRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QuerySoftwareItemsResponse

create_software_item(request)[source]

Creates a new software item in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateSoftwareItemRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateSoftwareItemResponse

get_test_adapter(request)[source]

Gets the test adapter associated with the identifier given in the request.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestAdapterRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetTestAdapterResponse

query_test_adapters(request)[source]

Perform an OData query on test adapters.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestAdaptersRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryTestAdaptersResponse

create_test_adapter(request)[source]

Creates a new test adapter in the metadata store.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestAdapterRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateTestAdapterResponse

register_schema(request)[source]

Registers a schema.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.RegisterSchemaRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.RegisterSchemaResponse

list_schemas(request)[source]

List the schemas that have been previously registered.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.ListSchemasRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.ListSchemasResponse

get_alias(request)[source]

Gets the target of a given alias.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.GetAliasRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.GetAliasResponse

query_aliases(request)[source]

Perform an OData query on the created aliases.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.QueryAliasesRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.QueryAliasesResponse

create_alias(request)[source]

Creates an alias of the specified metadata.

This alias can be used when creating other metadata or publishing.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateAliasRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateAliasResponse

delete_alias(request)[source]

Deletes a created alias.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.DeleteAliasRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.DeleteAliasResponse

create_from_json_document(request)[source]

Creates metadata from a JSON document.

Parameters:: request (ni.measurements.metadata.v1.metadata_store_service_pb2.CreateFromJsonDocumentRequest)
Return type:: ni.measurements.metadata.v1.metadata_store_service_pb2.CreateFromJsonDocumentResponse