ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc

Classes

`PinMapServiceStub`	Service to keep track of pin map resources.
`PinMapServiceAsyncStub`	Service to keep track of pin map resources.
`PinMapServiceServicer`	Service to keep track of pin map resources.

Functions

add_PinMapServiceServicer_to_server(servicer, server)

Package Contents

class ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.PinMapServiceStub(channel)

Service to keep track of pin map resources.

Parameters:: channel (Union[grpc.Channel, grpc.aio.Channel])

CreatePinMapFromXml: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.CreatePinMapFromXmlRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Registers pin map with the PinMapService and returns a pin map resource.

Status codes for errors:

INVALID_ARGUMENT: Pin map id is empty or has whitespace, or pin map xml string is not valid
ALREADY_EXISTS: Pin map resource with the specified pin map id already exists

UpdatePinMapFromXml: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.UpdatePinMapFromXmlRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Updates registered pin map contents and returns it. Creates and registers a pin map if a pin map resource for the specified pin map id is not found.

Status codes for errors:

INVALID_ARGUMENT: Pin map xml string is not valid

GetPinMap: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.GetPinMapRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Get registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryPins: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse]

Returns list of pins from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryRelays: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse]

Returns list of relays from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryResourceAccessInformation: grpc.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse]

Get instrument resource names, channels, and instrument type for the specified sites, pins or pin groups, relays or relay groups, instrument type in the registered pin map resource. Status codes for errors:

NOT_FOUND:
- Pin map resource for the specified pin map id is not found.
- Specified site number is not in the valid range for the registered pin map.
INVALID_ARGUMENT:
- Specified pin or relay is not present in the registered pin map resource.
- Empty string specified for a pin or relay name.

class ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.PinMapServiceAsyncStub

Service to keep track of pin map resources.

CreatePinMapFromXml: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.CreatePinMapFromXmlRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Registers pin map with the PinMapService and returns a pin map resource.

Status codes for errors:

INVALID_ARGUMENT: Pin map id is empty or has whitespace, or pin map xml string is not valid
ALREADY_EXISTS: Pin map resource with the specified pin map id already exists

UpdatePinMapFromXml: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.UpdatePinMapFromXmlRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Updates registered pin map contents and returns it. Creates and registers a pin map if a pin map resource for the specified pin map id is not found.

Status codes for errors:

INVALID_ARGUMENT: Pin map xml string is not valid

GetPinMap: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.GetPinMapRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]

Get registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryPins: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse]

Returns list of pins from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryRelays: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse]

Returns list of relays from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

QueryResourceAccessInformation: grpc.aio.UnaryUnaryMultiCallable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationRequest, ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse]

Get instrument resource names, channels, and instrument type for the specified sites, pins or pin groups, relays or relay groups, instrument type in the registered pin map resource. Status codes for errors:

NOT_FOUND:
- Pin map resource for the specified pin map id is not found.
- Specified site number is not in the valid range for the registered pin map.
INVALID_ARGUMENT:
- Specified pin or relay is not present in the registered pin map resource.
- Empty string specified for a pin or relay name.

class ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.PinMapServiceServicer

Service to keep track of pin map resources.

abstractmethod CreatePinMapFromXml(request, context)

Registers pin map with the PinMapService and returns a pin map resource.

Status codes for errors:

INVALID_ARGUMENT: Pin map id is empty or has whitespace, or pin map xml string is not valid
ALREADY_EXISTS: Pin map resource with the specified pin map id already exists

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.CreatePinMapFromXmlRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]]

abstractmethod UpdatePinMapFromXml(request, context)

Updates registered pin map contents and returns it. Creates and registers a pin map if a pin map resource for the specified pin map id is not found.

Status codes for errors:

INVALID_ARGUMENT: Pin map xml string is not valid

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.UpdatePinMapFromXmlRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]]

abstractmethod GetPinMap(request, context)

Get registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.GetPinMapRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.PinMap]]

abstractmethod QueryPins(request, context)

Returns list of pins from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryPinsResponse]]

abstractmethod QueryRelays(request, context)

Returns list of relays from the registered pin map resource.

Status codes for errors:

NOT_FOUND: Pin map resource for the specified pin map id is not found

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryRelaysResponse]]

abstractmethod QueryResourceAccessInformation(request, context)

Get instrument resource names, channels, and instrument type for the specified sites, pins or pin groups, relays or relay groups, instrument type in the registered pin map resource. Status codes for errors:

NOT_FOUND:
- Pin map resource for the specified pin map id is not found.
- Specified site number is not in the valid range for the registered pin map.
INVALID_ARGUMENT:
- Specified pin or relay is not present in the registered pin map resource.
- Empty string specified for a pin or relay name.

Parameters:

request (ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationRequest)
context (_ServicerContext)

Return type:

Union[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse, collections.abc.Awaitable[ni.measurementlink.pinmap.v1.pin_map_service_pb2.QueryResourceAccessInformationResponse]]

ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.add_PinMapServiceServicer_to_server(servicer, server)

Parameters:

servicer (PinMapServiceServicer)
server (Union[grpc.Server, grpc.aio.Server])

Return type:

None