ni.panels.v1.panel_service_pb2

Attributes

DESCRIPTOR
global___StartPanelRequest
global___StartPanelResponse
global___StopPanelRequest
global___StopPanelResponse
global___EnumeratePanelsRequest
global___PanelInformation
global___EnumeratePanelsResponse
global___GetValueRequest
global___GetValueResponse
global___TryGetValueRequest
global___TryGetValueResponse
global___SetValueRequest
global___SetValueResponse

Classes

StartPanelRequest	A StartPanelRequest message.
StartPanelResponse	A StartPanelResponse message.
StopPanelRequest	A StopPanelRequest message.
StopPanelResponse	A StopPanelResponse message.
EnumeratePanelsRequest	A EnumeratePanelsRequest message.
PanelInformation	A PanelInformation message.
EnumeratePanelsResponse	A EnumeratePanelsResponse message.
GetValueRequest	A GetValueRequest message.
GetValueResponse	A GetValueResponse message.
TryGetValueRequest	A TryGetValueRequest message.
TryGetValueResponse	A TryGetValueResponse message.
SetValueRequest	A SetValueRequest message.
SetValueResponse	A SetValueResponse message.

Module Contents

ni.panels.v1.panel_service_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class ni.panels.v1.panel_service_pb2.StartPanelRequest(*, panel_id=..., panel_configuration=...)

Bases: google.protobuf.message.Message

A StartPanelRequest message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

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

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

PANEL_CONFIGURATION_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel. Only alphanumeric characters and underscores are allowed.

property panel_configuration: google.protobuf.any_pb2.Any

Configuration for the panel, packed as a google.protobuf.Any

Return type:

google.protobuf.any_pb2.Any

__init__(*, panel_id=..., panel_configuration=...)

Parameters:

• panel_id (str)

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

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___StartPanelRequest

class ni.panels.v1.panel_service_pb2.StartPanelResponse(*, panel_url=...)

Bases: google.protobuf.message.Message

A StartPanelResponse message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

panel_url (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_URL_FIELD_NUMBER: int

panel_url: str

Location of the panel

__init__(*, panel_url=...)

Parameters:

panel_url (str)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___StartPanelResponse

class ni.panels.v1.panel_service_pb2.StopPanelRequest(*, panel_id=..., reset=...)

Bases: google.protobuf.message.Message

A StopPanelRequest message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

• reset (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

RESET_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel. Only alphanumeric characters and underscores are allowed.

reset: bool

Reset all storage associated with panel

__init__(*, panel_id=..., reset=...)

Parameters:

• panel_id (str)

• reset (bool)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___StopPanelRequest

class ni.panels.v1.panel_service_pb2.StopPanelResponse

Bases: google.protobuf.message.Message

A StopPanelResponse message.

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

__init__()

Return type:

None

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___StopPanelResponse

class ni.panels.v1.panel_service_pb2.EnumeratePanelsRequest

Bases: google.protobuf.message.Message

A EnumeratePanelsRequest message.

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

__init__()

Return type:

None

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___EnumeratePanelsRequest

class ni.panels.v1.panel_service_pb2.PanelInformation(*, panel_id=..., panel_url=..., value_ids=...)

Bases: google.protobuf.message.Message

A PanelInformation message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

• panel_url (str)

• value_ids (collections.abc.Iterable[str] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

PANEL_URL_FIELD_NUMBER: int

VALUE_IDS_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel

panel_url: str

Location of the panel

property value_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

IDs of all of the values associated with the panel

Return type:

google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

__init__(*, panel_id=..., panel_url=..., value_ids=...)

Parameters:

• panel_id (str)

• panel_url (str)

• value_ids (collections.abc.Iterable[str] | None)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___PanelInformation

class ni.panels.v1.panel_service_pb2.EnumeratePanelsResponse(*, panels=...)

Bases: google.protobuf.message.Message

A EnumeratePanelsResponse message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

panels (collections.abc.Iterable[global___PanelInformation] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANELS_FIELD_NUMBER: int

property panels: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___PanelInformation]

The list of panels available in the system

Return type:

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

__init__(*, panels=...)

Parameters:

panels (collections.abc.Iterable[global___PanelInformation] | None)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___EnumeratePanelsResponse

class ni.panels.v1.panel_service_pb2.GetValueRequest(*, panel_id=..., value_id=...)

Bases: google.protobuf.message.Message

A GetValueRequest message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

• value_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

VALUE_ID_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel. Only alphanumeric characters and underscores are allowed.

value_id: str

Unique ID of value. Only alphanumeric characters and underscores are allowed.

__init__(*, panel_id=..., value_id=...)

Parameters:

• panel_id (str)

• value_id (str)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___GetValueRequest

class ni.panels.v1.panel_service_pb2.GetValueResponse(*, value=...)

Bases: google.protobuf.message.Message

A GetValueResponse message.

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

The value, packed as a google.protobuf.Any. Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.

Return type:

google.protobuf.any_pb2.Any

__init__(*, value=...)

Parameters:

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

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___GetValueResponse

class ni.panels.v1.panel_service_pb2.TryGetValueRequest(*, panel_id=..., value_id=...)

Bases: google.protobuf.message.Message

A TryGetValueRequest message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

• value_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

VALUE_ID_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel. Only alphanumeric characters and underscores are allowed.

value_id: str

Unique ID of value. Only alphanumeric characters and underscores are allowed.

__init__(*, panel_id=..., value_id=...)

Parameters:

• panel_id (str)

• value_id (str)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___TryGetValueRequest

class ni.panels.v1.panel_service_pb2.TryGetValueResponse(*, value=...)

Bases: google.protobuf.message.Message

A TryGetValueResponse message.

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

The value (if it was found), packed as a google.protobuf.Any. Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.

Return type:

google.protobuf.any_pb2.Any

__init__(*, value=...)

Parameters:

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

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___TryGetValueResponse

class ni.panels.v1.panel_service_pb2.SetValueRequest(*, panel_id=..., value_id=..., value=..., notify=...)

Bases: google.protobuf.message.Message

A SetValueRequest message.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

• panel_id (str)

• value_id (str)

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

• notify (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

PANEL_ID_FIELD_NUMBER: int

VALUE_ID_FIELD_NUMBER: int

VALUE_FIELD_NUMBER: int

NOTIFY_FIELD_NUMBER: int

panel_id: str

Unique ID of the panel. Only alphanumeric characters and underscores are allowed.

value_id: str

Unique ID of the value. Only alphanumeric characters and underscores are allowed.

notify: bool

Notify other clients of this new value

property value: google.protobuf.any_pb2.Any

The value, packed as a google.protobuf.Any. Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.

Return type:

google.protobuf.any_pb2.Any

__init__(*, panel_id=..., value_id=..., value=..., notify=...)

Parameters:

• panel_id (str)

• value_id (str)

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

• notify (bool)

Return type:

None

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

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___SetValueRequest

class ni.panels.v1.panel_service_pb2.SetValueResponse

Bases: google.protobuf.message.Message

A SetValueResponse message.

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

__init__()

Return type:

None

__slots__ = []

__deepcopy__(memo=None)

__dir__()

Provides the list of all accessible Message attributes.

abstractmethod __eq__(other_msg)

Recursively compares two messages by value and structure.

__ne__(other_msg)

__hash__()

abstractmethod __str__()

Outputs a human-readable representation of the message.

abstractmethod __unicode__()

Outputs a human-readable representation of the message.

abstractmethod __contains__(field_name_or_key)

Checks if a certain field is set for the message.

Has presence fields return true if the field is set, false if the field is not set. Fields without presence do raise ValueError (this includes repeated fields, map fields, and implicit presence fields).

If field_name is not defined in the message descriptor, ValueError will be raised. Note: WKT Struct checks if the key is contained in fields. ListValue checks if the item is contained in the list.

Parameters:

field_name_or_key – For Struct, the key (str) of the fields map. For ListValue, any type that may be contained in the list. For other messages, name of the field (str) to check for presence.

Returns:

For Struct, whether the item is contained in fields. For ListValue,

whether the item is contained in the list. For other message, whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – For normal messages, if the field_name_or_key is not a member of this message or field_name_or_key is not a string.

abstractmethod MergeFrom(other_msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Parameters:

other_msg (Message) – A message to merge into the current message.

CopyFrom(other_msg)

Copies the content of the specified message into the current message.

The method clears the current message and then merges the specified message using MergeFrom.

Parameters:

other_msg (Message) – A message to copy into the current one.

abstractmethod Clear()

Clears all data that was set in the message.

abstractmethod SetInParent()

Mark this as present in the parent.

This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.

abstractmethod IsInitialized()

Checks if the message is initialized.

Returns:

The method returns True if the message is initialized (i.e. all of its required fields are set).

Return type:

bool

abstractmethod MergeFromString(serialized)

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

• If it’s a “repeated” field, we append to the end of our list.

• Else, if it’s a scalar, we overwrite our field.

• Else, (it’s a nonrepeated composite), we recursively merge into the existing composite.

Parameters:

serialized (bytes) – Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.

Returns:

The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Return type:

int

Raises:

DecodeError – if the input cannot be parsed.

ParseFromString(serialized)

Parse serialized protocol buffer data in binary form into this message.

Like MergeFromString(), except we clear the object first.

Raises:

message.DecodeError if the input cannot be parsed. –

abstractmethod SerializeToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:

EncodeError – if the message isn’t initialized (see IsInitialized()).

abstractmethod SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn’t check if the message is initialized.

Keyword Arguments:

deterministic (bool) – If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A serialized representation of the partial message.

Return type:

bytes

abstractmethod ListFields()

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

field descriptors and values for all fields in the message which are not empty. The values vary by field type.

Return type:

list[tuple(FieldDescriptor, value)]

abstractmethod 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.

abstractmethod 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.

abstractmethod 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

abstractmethod HasExtension(field_descriptor)

Checks if a certain extension is present for this message.

Extensions are retrieved using the Extensions mapping (if present).

Parameters:

field_descriptor – The field descriptor for the extension to check.

Returns:

Whether the extension is present for this message.

Return type:

bool

Raises:

KeyError – if the extension is repeated. Similar to repeated fields, there is no separate notion of presence: a “not present” repeated extension is an empty list.

abstractmethod ClearExtension(field_descriptor)

Clears the contents of a given extension.

Parameters:

field_descriptor – The field descriptor for the extension to clear.

abstractmethod UnknownFields()

Returns the UnknownFieldSet.

Returns:

The unknown fields stored in this message.

Return type:

UnknownFieldSet

abstractmethod DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

abstractmethod ByteSize()

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

The number of bytes required to serialize this message.

Return type:

int

classmethod FromString(s)

Abstractmethod:

abstractmethod _SetListener(message_listener)

Internal method used by the protocol message implementation. Clients should not call this directly.

Sets a listener that this message will call on certain state transitions.

The purpose of this method is to register back-edges from children to parents at runtime, for the purpose of setting “has” bits and byte-size-dirty bits in the parent and ancestor objects whenever a child or descendant object is modified.

If the client wants to disconnect this Message from the object tree, she explicitly sets callback to None.

If message_listener is None, unregisters any existing listener. Otherwise, message_listener must implement the MessageListener interface in internal/message_listener.py, and we discard any listener registered via a previous _SetListener() call.

__getstate__()

Support the pickle protocol.

__setstate__(state)

Support the pickle protocol.

__reduce__()

ni.panels.v1.panel_service_pb2.global___SetValueResponse