session_pb2 =========== .. py:module:: session_pb2 Attributes ---------- .. autoapisummary:: session_pb2.DESCRIPTOR session_pb2.SESSION_INITIALIZATION_BEHAVIOR_UNSPECIFIED session_pb2.SESSION_INITIALIZATION_BEHAVIOR_INITIALIZE_NEW session_pb2.SESSION_INITIALIZATION_BEHAVIOR_ATTACH_TO_EXISTING session_pb2.global___SessionInitializationBehavior session_pb2.global___Session session_pb2.global___DeviceProperties session_pb2.global___EnumerateDevicesRequest session_pb2.global___EnumerateDevicesResponse session_pb2.global___ReserveRequest session_pb2.global___ReserveResponse session_pb2.global___IsReservedByClientRequest session_pb2.global___IsReservedByClientResponse session_pb2.global___UnreserveRequest session_pb2.global___UnreserveResponse session_pb2.global___ResetServerRequest session_pb2.global___ResetServerResponse Classes ------- .. autoapisummary:: session_pb2.SessionInitializationBehavior session_pb2.Session session_pb2.DeviceProperties session_pb2.EnumerateDevicesRequest session_pb2.EnumerateDevicesResponse session_pb2.ReserveRequest session_pb2.ReserveResponse session_pb2.IsReservedByClientRequest session_pb2.IsReservedByClientResponse session_pb2.UnreserveRequest session_pb2.UnreserveResponse session_pb2.ResetServerRequest session_pb2.ResetServerResponse Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: SessionInitializationBehavior Bases: :py:obj:`_SessionInitializationBehavior` .. py:data:: SESSION_INITIALIZATION_BEHAVIOR_UNSPECIFIED :type: SessionInitializationBehavior .. py:data:: SESSION_INITIALIZATION_BEHAVIOR_INITIALIZE_NEW :type: SessionInitializationBehavior .. py:data:: SESSION_INITIALIZATION_BEHAVIOR_ATTACH_TO_EXISTING :type: SessionInitializationBehavior .. py:data:: global___SessionInitializationBehavior .. py:class:: Session(*, name = ..., id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: ID_FIELD_NUMBER :type: int .. py:attribute:: name :type: str .. py:attribute:: id :type: int .. py:method:: HasField(field_name) Checks if a certain field is set for the message. For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group) Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___Session .. py:class:: DeviceProperties(*, name = ..., model = ..., vendor = ..., serial_number = ..., product_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: NAME_FIELD_NUMBER :type: int .. py:attribute:: MODEL_FIELD_NUMBER :type: int .. py:attribute:: VENDOR_FIELD_NUMBER :type: int .. py:attribute:: SERIAL_NUMBER_FIELD_NUMBER :type: int .. py:attribute:: PRODUCT_ID_FIELD_NUMBER :type: int .. py:attribute:: name :type: str .. py:attribute:: model :type: str .. py:attribute:: vendor :type: str .. py:attribute:: serial_number :type: str .. py:attribute:: product_id :type: int .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___DeviceProperties .. py:class:: EnumerateDevicesRequest Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:data:: global___EnumerateDevicesRequest .. py:class:: EnumerateDevicesResponse(*, devices = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: DEVICES_FIELD_NUMBER :type: int .. py:property:: devices :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DeviceProperties] .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___EnumerateDevicesResponse .. py:class:: ReserveRequest(*, reservation_id = ..., client_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: RESERVATION_ID_FIELD_NUMBER :type: int .. py:attribute:: CLIENT_ID_FIELD_NUMBER :type: int .. py:attribute:: reservation_id :type: str client defined string representing a set of reservable resources .. py:attribute:: client_id :type: str client defined identifier for a specific client .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ReserveRequest .. py:class:: ReserveResponse(*, is_reserved = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: IS_RESERVED_FIELD_NUMBER :type: int .. py:attribute:: is_reserved :type: bool .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ReserveResponse .. py:class:: IsReservedByClientRequest(*, reservation_id = ..., client_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: RESERVATION_ID_FIELD_NUMBER :type: int .. py:attribute:: CLIENT_ID_FIELD_NUMBER :type: int .. py:attribute:: reservation_id :type: str client defined string representing a set of reservable resources .. py:attribute:: client_id :type: str client defined identifier for a specific client .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___IsReservedByClientRequest .. py:class:: IsReservedByClientResponse(*, is_reserved = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: IS_RESERVED_FIELD_NUMBER :type: int .. py:attribute:: is_reserved :type: bool .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___IsReservedByClientResponse .. py:class:: UnreserveRequest(*, reservation_id = ..., client_id = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: RESERVATION_ID_FIELD_NUMBER :type: int .. py:attribute:: CLIENT_ID_FIELD_NUMBER :type: int .. py:attribute:: reservation_id :type: str client defined string representing a set of reservable resources .. py:attribute:: client_id :type: str client defined identifier for a specific client .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___UnreserveRequest .. py:class:: UnreserveResponse(*, is_unreserved = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: IS_UNRESERVED_FIELD_NUMBER :type: int .. py:attribute:: is_unreserved :type: bool .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___UnreserveResponse .. py:class:: ResetServerRequest Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:data:: global___ResetServerRequest .. py:class:: ResetServerResponse(*, is_server_reset = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: IS_SERVER_RESET_FIELD_NUMBER :type: int .. py:attribute:: is_server_reset :type: bool .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___ResetServerResponse