ni.datamonikers.v1.data_moniker_pb2

Attributes

DESCRIPTOR
UNKNOWN
GRPC
SHARED_MEMORY
DOUBLE_BUFFERED_SHARED_MEMORY
SOCKETS
SOCKETS_LOW_LATENCY
HYPERVISOR_SOCKETS
RDMA
RDMA_LOW_LATENCY
global___SidebandStrategy
global___Moniker
global___MonikerValues
global___MonikerList
global___BeginMonikerSidebandStreamRequest
global___BeginMonikerSidebandStreamResponse
global___MonikerWriteRequest
global___MonikerReadResult
global___SidebandWriteRequest
global___SidebandReadResponse
global___StreamWriteResponse
global___ReadFromMonikerResult
global___WriteToMonikerRequest
global___WriteToMonikerResponse

Classes

SidebandStrategy
Moniker	Moniker is a unique identifier for a data source.
MonikerValues	Abstract base class for protocol messages.
MonikerList	Abstract base class for protocol messages.
BeginMonikerSidebandStreamRequest	Abstract base class for protocol messages.
BeginMonikerSidebandStreamResponse	Abstract base class for protocol messages.
MonikerWriteRequest	Abstract base class for protocol messages.
MonikerReadResult	Abstract base class for protocol messages.
SidebandWriteRequest	Abstract base class for protocol messages.
SidebandReadResponse	Abstract base class for protocol messages.
StreamWriteResponse	Abstract base class for protocol messages.
ReadFromMonikerResult	Abstract base class for protocol messages.
WriteToMonikerRequest	Abstract base class for protocol messages.
WriteToMonikerResponse	Abstract base class for protocol messages.

Package Contents

ni.datamonikers.v1.data_moniker_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.datamonikers.v1.data_moniker_pb2.SidebandStrategy

Bases: _SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.UNKNOWN: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.GRPC: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.SHARED_MEMORY: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.DOUBLE_BUFFERED_SHARED_MEMORY: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.SOCKETS: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.SOCKETS_LOW_LATENCY: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.HYPERVISOR_SOCKETS: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.RDMA: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.RDMA_LOW_LATENCY: SidebandStrategy

ni.datamonikers.v1.data_moniker_pb2.global___SidebandStrategy

class ni.datamonikers.v1.data_moniker_pb2.Moniker(*, service_location=..., data_source=..., data_instance=...)

Bases: google.protobuf.message.Message

Moniker is a unique identifier for a data source.

Parameters:

• service_location (str)

• data_source (str)

• data_instance (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

SERVICE_LOCATION_FIELD_NUMBER: int

DATA_SOURCE_FIELD_NUMBER: int

DATA_INSTANCE_FIELD_NUMBER: int

service_location: str

data_source: str

data_instance: int

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.datamonikers.v1.data_moniker_pb2.global___Moniker

class ni.datamonikers.v1.data_moniker_pb2.MonikerValues(*, values=...)

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:

values (collections.abc.Iterable[google.protobuf.any_pb2.Any] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VALUES_FIELD_NUMBER: int

property values: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.any_pb2.Any]

Return type:

google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.any_pb2.Any]

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.datamonikers.v1.data_moniker_pb2.global___MonikerValues

class ni.datamonikers.v1.data_moniker_pb2.MonikerList(*, is_initial_write=..., read_monikers=..., write_monikers=...)

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:

• is_initial_write (bool)

• read_monikers (collections.abc.Iterable[global___Moniker] | None)

• write_monikers (collections.abc.Iterable[global___Moniker] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_INITIAL_WRITE_FIELD_NUMBER: int

READ_MONIKERS_FIELD_NUMBER: int

WRITE_MONIKERS_FIELD_NUMBER: int

is_initial_write: bool

property read_monikers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

Return type:

google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

property write_monikers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

Return type:

google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker]

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.datamonikers.v1.data_moniker_pb2.global___MonikerList

class ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamRequest(*, strategy=..., monikers=...)

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:

• strategy (global___SidebandStrategy)

• monikers (global___MonikerList | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STRATEGY_FIELD_NUMBER: int

MONIKERS_FIELD_NUMBER: int

strategy: global___SidebandStrategy

property monikers: global___MonikerList

Return type:

global___MonikerList

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.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamRequest

class ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamResponse(*, strategy=..., connection_url=..., sideband_identifier=..., buffer_size=...)

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:

• strategy (global___SidebandStrategy)

• connection_url (str)

• sideband_identifier (str)

• buffer_size (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

STRATEGY_FIELD_NUMBER: int

CONNECTION_URL_FIELD_NUMBER: int

SIDEBAND_IDENTIFIER_FIELD_NUMBER: int

BUFFER_SIZE_FIELD_NUMBER: int

strategy: global___SidebandStrategy

connection_url: str

sideband_identifier: str

buffer_size: int

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.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamResponse

class ni.datamonikers.v1.data_moniker_pb2.MonikerWriteRequest(*, monikers=..., data=...)

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:

• monikers (global___MonikerList | None)

• data (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MONIKERS_FIELD_NUMBER: int

DATA_FIELD_NUMBER: int

property monikers: global___MonikerList

Return type:

global___MonikerList

property data: global___MonikerValues

Return type:

global___MonikerValues

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.datamonikers.v1.data_moniker_pb2.global___MonikerWriteRequest

class ni.datamonikers.v1.data_moniker_pb2.MonikerReadResult(*, data=...)

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:

data (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DATA_FIELD_NUMBER: int

property data: global___MonikerValues

Return type:

global___MonikerValues

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.datamonikers.v1.data_moniker_pb2.global___MonikerReadResult

class ni.datamonikers.v1.data_moniker_pb2.SidebandWriteRequest(*, cancel=..., values=...)

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:

• cancel (bool)

• values (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CANCEL_FIELD_NUMBER: int

VALUES_FIELD_NUMBER: int

cancel: bool

property values: global___MonikerValues

Return type:

global___MonikerValues

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.datamonikers.v1.data_moniker_pb2.global___SidebandWriteRequest

class ni.datamonikers.v1.data_moniker_pb2.SidebandReadResponse(*, cancel=..., values=...)

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:

• cancel (bool)

• values (global___MonikerValues | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

CANCEL_FIELD_NUMBER: int

VALUES_FIELD_NUMBER: int

cancel: bool

property values: global___MonikerValues

Return type:

global___MonikerValues

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.datamonikers.v1.data_moniker_pb2.global___SidebandReadResponse

class ni.datamonikers.v1.data_moniker_pb2.StreamWriteResponse

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.datamonikers.v1.data_moniker_pb2.global___StreamWriteResponse

class ni.datamonikers.v1.data_moniker_pb2.ReadFromMonikerResult(*, 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:

value (google.protobuf.any_pb2.Any | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

VALUE_FIELD_NUMBER: int

property value: google.protobuf.any_pb2.Any

Return type:

google.protobuf.any_pb2.Any

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.datamonikers.v1.data_moniker_pb2.global___ReadFromMonikerResult

class ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerRequest(*, moniker=..., 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:

• moniker (global___Moniker | None)

• value (google.protobuf.any_pb2.Any | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

MONIKER_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

property moniker: global___Moniker

Return type:

global___Moniker

property value: google.protobuf.any_pb2.Any

Return type:

google.protobuf.any_pb2.Any

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.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerRequest

class ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerResponse

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.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerResponse