ni.datamonikers.v1.data_moniker_pb2 =================================== .. py:module:: ni.datamonikers.v1.data_moniker_pb2 Attributes ---------- .. autoapisummary:: ni.datamonikers.v1.data_moniker_pb2.DESCRIPTOR ni.datamonikers.v1.data_moniker_pb2.UNKNOWN ni.datamonikers.v1.data_moniker_pb2.GRPC ni.datamonikers.v1.data_moniker_pb2.SHARED_MEMORY ni.datamonikers.v1.data_moniker_pb2.DOUBLE_BUFFERED_SHARED_MEMORY ni.datamonikers.v1.data_moniker_pb2.SOCKETS ni.datamonikers.v1.data_moniker_pb2.SOCKETS_LOW_LATENCY ni.datamonikers.v1.data_moniker_pb2.HYPERVISOR_SOCKETS ni.datamonikers.v1.data_moniker_pb2.RDMA ni.datamonikers.v1.data_moniker_pb2.RDMA_LOW_LATENCY ni.datamonikers.v1.data_moniker_pb2.global___SidebandStrategy ni.datamonikers.v1.data_moniker_pb2.global___Moniker ni.datamonikers.v1.data_moniker_pb2.global___MonikerValues ni.datamonikers.v1.data_moniker_pb2.global___MonikerList ni.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamRequest ni.datamonikers.v1.data_moniker_pb2.global___BeginMonikerSidebandStreamResponse ni.datamonikers.v1.data_moniker_pb2.global___MonikerWriteRequest ni.datamonikers.v1.data_moniker_pb2.global___MonikerReadResult ni.datamonikers.v1.data_moniker_pb2.global___SidebandWriteRequest ni.datamonikers.v1.data_moniker_pb2.global___SidebandReadResponse ni.datamonikers.v1.data_moniker_pb2.global___StreamWriteResponse ni.datamonikers.v1.data_moniker_pb2.global___ReadFromMonikerResult ni.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerRequest ni.datamonikers.v1.data_moniker_pb2.global___WriteToMonikerResponse Classes ------- .. autoapisummary:: ni.datamonikers.v1.data_moniker_pb2.SidebandStrategy ni.datamonikers.v1.data_moniker_pb2.Moniker ni.datamonikers.v1.data_moniker_pb2.MonikerValues ni.datamonikers.v1.data_moniker_pb2.MonikerList ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamRequest ni.datamonikers.v1.data_moniker_pb2.BeginMonikerSidebandStreamResponse ni.datamonikers.v1.data_moniker_pb2.MonikerWriteRequest ni.datamonikers.v1.data_moniker_pb2.MonikerReadResult ni.datamonikers.v1.data_moniker_pb2.SidebandWriteRequest ni.datamonikers.v1.data_moniker_pb2.SidebandReadResponse ni.datamonikers.v1.data_moniker_pb2.StreamWriteResponse ni.datamonikers.v1.data_moniker_pb2.ReadFromMonikerResult ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerRequest ni.datamonikers.v1.data_moniker_pb2.WriteToMonikerResponse Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: SidebandStrategy Bases: :py:obj:`_SidebandStrategy` .. py:data:: UNKNOWN :type: SidebandStrategy .. py:data:: GRPC :type: SidebandStrategy .. py:data:: SHARED_MEMORY :type: SidebandStrategy .. py:data:: DOUBLE_BUFFERED_SHARED_MEMORY :type: SidebandStrategy .. py:data:: SOCKETS :type: SidebandStrategy .. py:data:: SOCKETS_LOW_LATENCY :type: SidebandStrategy .. py:data:: HYPERVISOR_SOCKETS :type: SidebandStrategy .. py:data:: RDMA :type: SidebandStrategy .. py:data:: RDMA_LOW_LATENCY :type: SidebandStrategy .. py:data:: global___SidebandStrategy .. py:class:: Moniker(*, service_location = ..., data_source = ..., data_instance = ...) Bases: :py:obj:`google.protobuf.message.Message` Moniker is a unique identifier for a data source. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: SERVICE_LOCATION_FIELD_NUMBER :type: int .. py:attribute:: DATA_SOURCE_FIELD_NUMBER :type: int .. py:attribute:: DATA_INSTANCE_FIELD_NUMBER :type: int .. py:attribute:: service_location :type: str .. py:attribute:: data_source :type: str .. py:attribute:: data_instance :type: int .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___Moniker .. py:class:: MonikerValues(*, values = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: VALUES_FIELD_NUMBER :type: int .. py:property:: values :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[google.protobuf.any_pb2.Any] .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___MonikerValues .. py:class:: MonikerList(*, is_initial_write = ..., read_monikers = ..., write_monikers = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: IS_INITIAL_WRITE_FIELD_NUMBER :type: int .. py:attribute:: READ_MONIKERS_FIELD_NUMBER :type: int .. py:attribute:: WRITE_MONIKERS_FIELD_NUMBER :type: int .. py:attribute:: is_initial_write :type: bool .. py:property:: read_monikers :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker] .. py:property:: write_monikers :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Moniker] .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___MonikerList .. py:class:: BeginMonikerSidebandStreamRequest(*, strategy = ..., monikers = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: STRATEGY_FIELD_NUMBER :type: int .. py:attribute:: MONIKERS_FIELD_NUMBER :type: int .. py:attribute:: strategy :type: global___SidebandStrategy .. py:property:: monikers :type: global___MonikerList .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___BeginMonikerSidebandStreamRequest .. py:class:: BeginMonikerSidebandStreamResponse(*, strategy = ..., connection_url = ..., sideband_identifier = ..., buffer_size = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: STRATEGY_FIELD_NUMBER :type: int .. py:attribute:: CONNECTION_URL_FIELD_NUMBER :type: int .. py:attribute:: SIDEBAND_IDENTIFIER_FIELD_NUMBER :type: int .. py:attribute:: BUFFER_SIZE_FIELD_NUMBER :type: int .. py:attribute:: strategy :type: global___SidebandStrategy .. py:attribute:: connection_url :type: str .. py:attribute:: sideband_identifier :type: str .. py:attribute:: buffer_size :type: int .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___BeginMonikerSidebandStreamResponse .. py:class:: MonikerWriteRequest(*, monikers = ..., data = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: MONIKERS_FIELD_NUMBER :type: int .. py:attribute:: DATA_FIELD_NUMBER :type: int .. py:property:: monikers :type: global___MonikerList .. py:property:: data :type: global___MonikerValues .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group) Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___MonikerWriteRequest .. py:class:: MonikerReadResult(*, data = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DATA_FIELD_NUMBER :type: int .. py:property:: data :type: global___MonikerValues .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___MonikerReadResult .. py:class:: SidebandWriteRequest(*, cancel = ..., values = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: CANCEL_FIELD_NUMBER :type: int .. py:attribute:: VALUES_FIELD_NUMBER :type: int .. py:attribute:: cancel :type: bool .. py:property:: values :type: global___MonikerValues .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___SidebandWriteRequest .. py:class:: SidebandReadResponse(*, cancel = ..., values = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: CANCEL_FIELD_NUMBER :type: int .. py:attribute:: VALUES_FIELD_NUMBER :type: int .. py:attribute:: cancel :type: bool .. py:property:: values :type: global___MonikerValues .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___SidebandReadResponse .. py:class:: StreamWriteResponse Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:data:: global___StreamWriteResponse .. py:class:: ReadFromMonikerResult(*, value = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: VALUE_FIELD_NUMBER :type: int .. py:property:: value :type: google.protobuf.any_pb2.Any .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ReadFromMonikerResult .. py:class:: WriteToMonikerRequest(*, moniker = ..., value = ...) Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: MONIKER_FIELD_NUMBER :type: int .. py:attribute:: VALUE_FIELD_NUMBER :type: int .. py:property:: moniker :type: global___Moniker .. py:property:: value :type: google.protobuf.any_pb2.Any .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___WriteToMonikerRequest .. py:class:: WriteToMonikerResponse Bases: :py:obj:`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. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:data:: global___WriteToMonikerResponse