ni.measurementlink.sessionmanagement.v1.session_management_service_pb2

Attributes

`DESCRIPTOR`
`global___SessionInformation`
`global___ChannelMapping`
`global___MultiplexerSessionInformation`
`global___ReserveSessionsRequest`
`global___ReserveSessionsResponse`
`global___UnreserveSessionsRequest`
`global___UnreserveSessionsResponse`
`global___RegisterSessionsRequest`
`global___RegisterSessionsResponse`
`global___UnregisterSessionsRequest`
`global___UnregisterSessionsResponse`
`global___ReserveAllRegisteredSessionsRequest`
`global___ReserveAllRegisteredSessionsResponse`
`global___RegisterMultiplexerSessionsRequest`
`global___RegisterMultiplexerSessionsResponse`
`global___UnregisterMultiplexerSessionsRequest`
`global___UnregisterMultiplexerSessionsResponse`
`global___GetMultiplexerSessionsRequest`
`global___GetMultiplexerSessionsResponse`
`global___GetAllRegisteredMultiplexerSessionsRequest`
`global___GetAllRegisteredMultiplexerSessionsResponse`
`global___ResolvedPinsOrRelays`
`global___GetSessionsRequest`
`global___GetSessionsResponse`

Classes

`SessionInformation`	Abstract base class for protocol messages.
`ChannelMapping`	Abstract base class for protocol messages.
`MultiplexerSessionInformation`	Abstract base class for protocol messages.
`ReserveSessionsRequest`	Abstract base class for protocol messages.
`ReserveSessionsResponse`	Abstract base class for protocol messages.
`UnreserveSessionsRequest`	Abstract base class for protocol messages.
`UnreserveSessionsResponse`	Abstract base class for protocol messages.
`RegisterSessionsRequest`	Abstract base class for protocol messages.
`RegisterSessionsResponse`	Abstract base class for protocol messages.
`UnregisterSessionsRequest`	Abstract base class for protocol messages.
`UnregisterSessionsResponse`	Abstract base class for protocol messages.
`ReserveAllRegisteredSessionsRequest`	Abstract base class for protocol messages.
`ReserveAllRegisteredSessionsResponse`	Abstract base class for protocol messages.
`RegisterMultiplexerSessionsRequest`	Abstract base class for protocol messages.
`RegisterMultiplexerSessionsResponse`	Abstract base class for protocol messages.
`UnregisterMultiplexerSessionsRequest`	Abstract base class for protocol messages.
`UnregisterMultiplexerSessionsResponse`	Abstract base class for protocol messages.
`GetMultiplexerSessionsRequest`	Abstract base class for protocol messages.
`GetMultiplexerSessionsResponse`	Abstract base class for protocol messages.
`GetAllRegisteredMultiplexerSessionsRequest`	Abstract base class for protocol messages.
`GetAllRegisteredMultiplexerSessionsResponse`	Abstract base class for protocol messages.
`ResolvedPinsOrRelays`	Abstract base class for protocol messages.
`GetSessionsRequest`	Abstract base class for protocol messages.
`GetSessionsResponse`	Abstract base class for protocol messages.

Package Contents

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.SessionInformation(*, session=..., resource_name=..., channel_list=..., instrument_type_id=..., session_exists=..., session_reserved=..., channel_mappings=..., annotations=...)

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:

session (session_pb2.Session | None)
resource_name (str)
channel_list (str)
instrument_type_id (str)
session_exists (bool)
session_reserved (bool)
channel_mappings (collections.abc.Iterable[global___ChannelMapping] | None)
annotations (collections.abc.Mapping[str, str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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:

key (str)
value (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: str

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

SESSION_FIELD_NUMBER: int

RESOURCE_NAME_FIELD_NUMBER: int

CHANNEL_LIST_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

SESSION_EXISTS_FIELD_NUMBER: int

SESSION_RESERVED_FIELD_NUMBER: int

CHANNEL_MAPPINGS_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

resource_name: str: Resource name used to open this session in the driver. This field is readonly.

channel_list: str: Channel list used for driver initialization and measurement methods. This field is empty for any SessionInformation returned from ReserveAllRegisteredSessions. This field is readonly.

instrument_type_id: str

Instrument type ID to identify which type of instrument the session represents.

The session management service has built in instrument definitions using the following NI driver based instrument type ids:

“niDCPower”
“niDigitalPattern”
“niScope”
“niDMM”
“niDAQmx”
“niFGen”
“niRelayDriver”

For custom instruments the user defined instrument type id is defined in the pin map file or custom session management plugin service.

This field is readonly.

session_exists: bool: Indicates whether the session has been created and registered with the Session Manager. This field is readonly.

session_reserved: bool: Indicates whether the session has been reserved with the Session Manager. This field is readonly.

property session: session_pb2.Session

Session identifier used to identify the session in the session management service, as well as in driver services such as grpc-device. This field is readonly.

Return type:: session_pb2.Session

property channel_mappings: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ChannelMapping]

List of site and I/O resource mappings with optional multiplexer information for each channel in the channel_list. Each item represents a channel-to-I/O-resource connection for this instrument resource. In the case of shared pins, there is a separate item for each connection. This field is empty for any SessionInformation returned from ReserveAllRegisteredSessions. This field is readonly.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ChannelMapping]

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. A set of annotations attached to the session.

For example, the annotations can provide a description of the session or identify who reserved a session.

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

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

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___SessionInformation

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ChannelMapping(*, pin_or_relay_name=..., site=..., channel=..., multiplexer_resource_name=..., multiplexer_route=...)

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:

pin_or_relay_name (str)
site (int)
channel (str)
multiplexer_resource_name (str)
multiplexer_route (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_OR_RELAY_NAME_FIELD_NUMBER: int

SITE_FIELD_NUMBER: int

CHANNEL_FIELD_NUMBER: int

MULTIPLEXER_RESOURCE_NAME_FIELD_NUMBER: int

MULTIPLEXER_ROUTE_FIELD_NUMBER: int

pin_or_relay_name: str: The I/O resource that is mapped to a channel.

site: int: The site on which the I/O resource is mapped to a channel. For system pins/relays the site number is -1 since they do not belong to a specific site.

channel: str: The channel to which the I/O resource is mapped on this site.

multiplexer_resource_name: str: The multiplexer resource name is used to open the multiplexer session in the driver.

multiplexer_route: str: The multiplexer route through which the pin is connected to an instrument’s channel.

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ChannelMapping

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.MultiplexerSessionInformation(*, session=..., resource_name=..., multiplexer_type_id=..., session_exists=..., annotations=...)

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:

session (session_pb2.Session | None)
resource_name (str)
multiplexer_type_id (str)
session_exists (bool)
annotations (collections.abc.Mapping[str, str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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:

key (str)
value (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: str

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

SESSION_FIELD_NUMBER: int

RESOURCE_NAME_FIELD_NUMBER: int

MULTIPLEXER_TYPE_ID_FIELD_NUMBER: int

SESSION_EXISTS_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

resource_name: str: Resource name is used to open this session in the driver. This field is readonly.

multiplexer_type_id: str: User-defined identifier for the multiplexer type in the pin map editor. This field is readonly.

session_exists: bool: Indicates whether the session exists in the Session Manager. This indicates whether the session has been created. This field is readonly.

property session: session_pb2.Session

Session identifier used to identify the session in the session management service, as well as in driver services such as grpc-device. This field is readonly.

Return type:: session_pb2.Session

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. A set of annotations attached to the session.

For example, the annotations can provide a description of the session or identify who reserved a session.

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

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

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___MultiplexerSessionInformation

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ReserveSessionsRequest(*, pin_map_context=..., pin_or_relay_names=..., instrument_type_id=..., timeout_in_milliseconds=..., annotations=...)

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:

pin_map_context (ni.measurementlink.pin_map_context_pb2.PinMapContext | None)
pin_or_relay_names (collections.abc.Iterable[str] | None)
instrument_type_id (str)
timeout_in_milliseconds (int)
annotations (collections.abc.Mapping[str, str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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:

key (str)
value (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: str

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

PIN_MAP_CONTEXT_FIELD_NUMBER: int

PIN_OR_RELAY_NAMES_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

TIMEOUT_IN_MILLISECONDS_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

instrument_type_id: str

Optional. Instrument type ID for the measurement. If unspecified, reserve sessions for all instrument types connected in the registered pin map resource.

The session management service has built in instrument definitions using the following NI driver based instrument type ids:

“niDCPower”
“niDigitalPattern”
“niScope”
“niDMM”
“niDAQmx”
“niFGen”
“niRelayDriver”

For custom instruments the user defined instrument type id is defined in the pin map file or custom session management plugin service.

timeout_in_milliseconds: int: Optional. Timeout for the reservation request. Allowed values: 0 (non-blocking, fails immediately if resources cannot be reserved), -1 (infinite timeout), or any other positive numeric value (wait for that number of milliseconds)

property pin_map_context: ni.measurementlink.pin_map_context_pb2.PinMapContext

Optional. Includes the pin map ID for the pin map in the Pin Map Service, as well as the list of sites for the measurement. If unspecified, specify non-pin I/O resources for pin_or_relay_names.

Return type:: ni.measurementlink.pin_map_context_pb2.PinMapContext

property pin_or_relay_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional. List of I/O resources (pins, pin groups, relays, relay groups, or channels) to use for the measurement. If unspecified, reserve sessions for all pins and relays in the registered pin map resource.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. A set of annotations to add to the session for the duration of the reservation.

These annotations will automatically be cleared when the session is unreserved.

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

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

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ReserveSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ReserveSessionsResponse(*, sessions=..., multiplexer_sessions=..., group_mappings=...)

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:

sessions (collections.abc.Iterable[global___SessionInformation] | None)
multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)
group_mappings (collections.abc.Mapping[str, global___ResolvedPinsOrRelays] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class GroupMappingsEntry(*, 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:

key (str)
value (global___ResolvedPinsOrRelays | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

property value: global___ResolvedPinsOrRelays

Return type:: global___ResolvedPinsOrRelays

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

SESSIONS_FIELD_NUMBER: int

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

GROUP_MAPPINGS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

List of information needed to create or use each session for the given I/O resource, site, and instrument type ID.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

List of information needed to create or use each multiplexer session for the given I/O resource, site, and instrument type ID.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

property group_mappings: google.protobuf.internal.containers.MessageMap[str, global___ResolvedPinsOrRelays]

Represents the mapping between pin or relay groups and their respective pin or relay names.

Return type:: google.protobuf.internal.containers.MessageMap[str, global___ResolvedPinsOrRelays]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ReserveSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnreserveSessionsRequest(*, sessions=...)

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:: sessions (collections.abc.Iterable[global___SessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SESSIONS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

Required. List of information of sessions to be unreserved in the session management service.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnreserveSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnreserveSessionsResponse

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnreserveSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.RegisterSessionsRequest(*, sessions=...)

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:: sessions (collections.abc.Iterable[global___SessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SESSIONS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

Required. List of sessions to register with the session management service to track as the sessions are open.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___RegisterSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.RegisterSessionsResponse

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___RegisterSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnregisterSessionsRequest(*, sessions=...)

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:: sessions (collections.abc.Iterable[global___SessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SESSIONS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

Required. List of sessions to unregister with the session management service to mark them as sessions were closed.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnregisterSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnregisterSessionsResponse

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnregisterSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ReserveAllRegisteredSessionsRequest(*, timeout_in_milliseconds=..., instrument_type_id=..., annotations=...)

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:

timeout_in_milliseconds (int)
instrument_type_id (str)
annotations (collections.abc.Mapping[str, str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

class AnnotationsEntry(*, 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:

key (str)
value (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

KEY_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

key: str

value: str

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

TIMEOUT_IN_MILLISECONDS_FIELD_NUMBER: int

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

ANNOTATIONS_FIELD_NUMBER: int

timeout_in_milliseconds: int: Optional. Timeout for the reservation request. Allowed values: 0 (non-blocking, fails immediately if resources cannot be reserved), -1 (infinite timeout), or any other positive numeric value (wait for that number of milliseconds)

instrument_type_id: str

Optional. Instrument type ID of the registered sessions to reserve. If unspecified, reserve sessions for all instrument types connected in the registered pin map resource.

The session management service has built in instrument definitions using the following NI driver based instrument type ids:

“niDCPower”
“niDigitalPattern”
“niScope”
“niDMM”
“niDAQmx”
“niFGen”
“niRelayDriver”

For custom instruments the user defined instrument type id is defined in the pin map file or custom session management plugin service.

property annotations: google.protobuf.internal.containers.ScalarMap[str, str]

Optional. A set of annotations to add to the session for the duration of the reservation.

These annotations will automatically be cleared when the session is unreserved.

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ReserveAllRegisteredSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ReserveAllRegisteredSessionsResponse(*, sessions=...)

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:: sessions (collections.abc.Iterable[global___SessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SESSIONS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

Sessions currently registered in the session management service.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ReserveAllRegisteredSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.RegisterMultiplexerSessionsRequest(*, multiplexer_sessions=...)

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:: multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

Required. List of multiplexer sessions to register with the session management service to track as the sessions are open.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___RegisterMultiplexerSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.RegisterMultiplexerSessionsResponse

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___RegisterMultiplexerSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnregisterMultiplexerSessionsRequest(*, multiplexer_sessions=...)

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:: multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

Required. List of multiplexer sessions to unregister with the session management service to mark them as sessions were closed.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnregisterMultiplexerSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.UnregisterMultiplexerSessionsResponse

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.

DESCRIPTOR: google.protobuf.descriptor.Descriptor

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___UnregisterMultiplexerSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetMultiplexerSessionsRequest(*, pin_map_context=..., multiplexer_type_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:

pin_map_context (ni.measurementlink.pin_map_context_pb2.PinMapContext | None)
multiplexer_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_MAP_CONTEXT_FIELD_NUMBER: int

MULTIPLEXER_TYPE_ID_FIELD_NUMBER: int

multiplexer_type_id: str: Optional. User-defined identifier for the multiplexer type in the pin map editor. If unspecified, information for all multiplexer types is returned.

property pin_map_context: ni.measurementlink.pin_map_context_pb2.PinMapContext

Required. Includes the pin map ID for the pin map in the Pin Map Service, as well as the list of sites for the measurement.

Return type:: ni.measurementlink.pin_map_context_pb2.PinMapContext

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

ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetMultiplexerSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetMultiplexerSessionsResponse(*, multiplexer_sessions=...)

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:: multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

List of information needed to create or use each multiplexer session for the given pin map context and multiplexer type ID.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetMultiplexerSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetAllRegisteredMultiplexerSessionsRequest(*, multiplexer_type_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:: multiplexer_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MULTIPLEXER_TYPE_ID_FIELD_NUMBER: int

multiplexer_type_id: str: Optional. User-defined identifier for the multiplexer type in the pin map editor. If unspecified, information for all registered multiplexer types is returned.

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetAllRegisteredMultiplexerSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetAllRegisteredMultiplexerSessionsResponse(*, multiplexer_sessions=...)

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:: multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

Multiplexer sessions currently registered in the session management service.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetAllRegisteredMultiplexerSessionsResponse

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.ResolvedPinsOrRelays(*, pin_or_relay_names=...)

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:: pin_or_relay_names (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PIN_OR_RELAY_NAMES_FIELD_NUMBER: int

property pin_or_relay_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

List of pin or relay names in the pin or relay group.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___ResolvedPinsOrRelays

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetSessionsRequest(*, instrument_type_id=..., multiplexer_type_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:

instrument_type_id (str)
multiplexer_type_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

INSTRUMENT_TYPE_ID_FIELD_NUMBER: int

MULTIPLEXER_TYPE_ID_FIELD_NUMBER: int

instrument_type_id: str: Optional. Instrument type ID of the instruments. If unspecified, information for all instrument types is returned.

multiplexer_type_id: str: Optional. User-defined identifier for the multiplexers. If unspecified, information for all registered multiplexer types is returned.

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetSessionsRequest

class ni.measurementlink.sessionmanagement.v1.session_management_service_pb2.GetSessionsResponse(*, sessions=..., multiplexer_sessions=...)

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:

sessions (collections.abc.Iterable[global___SessionInformation] | None)
multiplexer_sessions (collections.abc.Iterable[global___MultiplexerSessionInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SESSIONS_FIELD_NUMBER: int

MULTIPLEXER_SESSIONS_FIELD_NUMBER: int

property sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

List of reserved or registered instrument sessions.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SessionInformation]

property multiplexer_sessions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

List of registered multiplexer sessions.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MultiplexerSessionInformation]

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.measurementlink.sessionmanagement.v1.session_management_service_pb2.global___GetSessionsResponse