session_pb2

Attributes

`DESCRIPTOR`
`SESSION_INITIALIZATION_BEHAVIOR_UNSPECIFIED`
`SESSION_INITIALIZATION_BEHAVIOR_INITIALIZE_NEW`
`SESSION_INITIALIZATION_BEHAVIOR_ATTACH_TO_EXISTING`
`global___SessionInitializationBehavior`
`global___Session`
`global___DeviceProperties`
`global___EnumerateDevicesRequest`
`global___EnumerateDevicesResponse`
`global___ReserveRequest`
`global___ReserveResponse`
`global___IsReservedByClientRequest`
`global___IsReservedByClientResponse`
`global___UnreserveRequest`
`global___UnreserveResponse`
`global___ResetServerRequest`
`global___ResetServerResponse`

Classes

`SessionInitializationBehavior`
`Session`	Abstract base class for protocol messages.
`DeviceProperties`	Abstract base class for protocol messages.
`EnumerateDevicesRequest`	Abstract base class for protocol messages.
`EnumerateDevicesResponse`	Abstract base class for protocol messages.
`ReserveRequest`	Abstract base class for protocol messages.
`ReserveResponse`	Abstract base class for protocol messages.
`IsReservedByClientRequest`	Abstract base class for protocol messages.
`IsReservedByClientResponse`	Abstract base class for protocol messages.
`UnreserveRequest`	Abstract base class for protocol messages.
`UnreserveResponse`	Abstract base class for protocol messages.
`ResetServerRequest`	Abstract base class for protocol messages.
`ResetServerResponse`	Abstract base class for protocol messages.

Package Contents

session_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class session_pb2.SessionInitializationBehavior: Bases: _SessionInitializationBehavior

session_pb2.SESSION_INITIALIZATION_BEHAVIOR_UNSPECIFIED: SessionInitializationBehavior

session_pb2.SESSION_INITIALIZATION_BEHAVIOR_INITIALIZE_NEW: SessionInitializationBehavior

session_pb2.SESSION_INITIALIZATION_BEHAVIOR_ATTACH_TO_EXISTING: SessionInitializationBehavior

session_pb2.global___SessionInitializationBehavior

class session_pb2.Session(*, name=..., id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:

name (str)
id (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

ID_FIELD_NUMBER: int

name: str

id: int

HasField(field_name)

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

WhichOneof(oneof_group)

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

session_pb2.global___Session

class session_pb2.DeviceProperties(*, name=..., model=..., vendor=..., serial_number=..., product_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:

name (str)
model (str)
vendor (str)
serial_number (str)
product_id (int)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

NAME_FIELD_NUMBER: int

MODEL_FIELD_NUMBER: int

VENDOR_FIELD_NUMBER: int

SERIAL_NUMBER_FIELD_NUMBER: int

PRODUCT_ID_FIELD_NUMBER: int

name: str

model: str

vendor: str

serial_number: str

product_id: int

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___DeviceProperties

class session_pb2.EnumerateDevicesRequest

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

DESCRIPTOR: google.protobuf.descriptor.Descriptor

session_pb2.global___EnumerateDevicesRequest

class session_pb2.EnumerateDevicesResponse(*, devices=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:: devices (collections.abc.Iterable[global___DeviceProperties] | None)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

DEVICES_FIELD_NUMBER: int

property devices: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DeviceProperties]

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

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___EnumerateDevicesResponse

class session_pb2.ReserveRequest(*, reservation_id=..., client_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:

reservation_id (str)
client_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

RESERVATION_ID_FIELD_NUMBER: int

CLIENT_ID_FIELD_NUMBER: int

reservation_id: str: client defined string representing a set of reservable resources

client_id: str: client defined identifier for a specific client

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___ReserveRequest

class session_pb2.ReserveResponse(*, is_reserved=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:: is_reserved (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_RESERVED_FIELD_NUMBER: int

is_reserved: bool

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___ReserveResponse

class session_pb2.IsReservedByClientRequest(*, reservation_id=..., client_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:

reservation_id (str)
client_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

RESERVATION_ID_FIELD_NUMBER: int

CLIENT_ID_FIELD_NUMBER: int

reservation_id: str: client defined string representing a set of reservable resources

client_id: str: client defined identifier for a specific client

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___IsReservedByClientRequest

class session_pb2.IsReservedByClientResponse(*, is_reserved=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:: is_reserved (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_RESERVED_FIELD_NUMBER: int

is_reserved: bool

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___IsReservedByClientResponse

class session_pb2.UnreserveRequest(*, reservation_id=..., client_id=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:

reservation_id (str)
client_id (str)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

RESERVATION_ID_FIELD_NUMBER: int

CLIENT_ID_FIELD_NUMBER: int

reservation_id: str: client defined string representing a set of reservable resources

client_id: str: client defined identifier for a specific client

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___UnreserveRequest

class session_pb2.UnreserveResponse(*, is_unreserved=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:: is_unreserved (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_UNRESERVED_FIELD_NUMBER: int

is_unreserved: bool

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___UnreserveResponse

class session_pb2.ResetServerRequest

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

DESCRIPTOR: google.protobuf.descriptor.Descriptor

session_pb2.global___ResetServerRequest

class session_pb2.ResetServerResponse(*, is_server_reset=...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

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

Parameters:: is_server_reset (bool)

DESCRIPTOR: google.protobuf.descriptor.Descriptor

IS_SERVER_RESET_FIELD_NUMBER: int

is_server_reset: bool

ClearField(field_name)

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

session_pb2.global___ResetServerResponse