viam.gen.service.shell.v1.shell_pb2 =================================== .. py:module:: viam.gen.service.shell.v1.shell_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.service.shell.v1.shell_pb2.DESCRIPTOR viam.gen.service.shell.v1.shell_pb2.COPY_FILES_SOURCE_TYPE_UNSPECIFIED viam.gen.service.shell.v1.shell_pb2.COPY_FILES_SOURCE_TYPE_SINGLE_FILE viam.gen.service.shell.v1.shell_pb2.COPY_FILES_SOURCE_TYPE_SINGLE_DIRECTORY viam.gen.service.shell.v1.shell_pb2.COPY_FILES_SOURCE_TYPE_MULTIPLE_FILES viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesSourceType viam.gen.service.shell.v1.shell_pb2.Global___ShellRequest viam.gen.service.shell.v1.shell_pb2.Global___ShellResponse viam.gen.service.shell.v1.shell_pb2.Global___FileData viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesToMachineRequestMetadata viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesToMachineRequest viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesToMachineResponse viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesFromMachineRequestMetadata viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesFromMachineRequest viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesFromMachineResponseMetadata viam.gen.service.shell.v1.shell_pb2.Global___CopyFilesFromMachineResponse Classes ------- .. autoapisummary:: viam.gen.service.shell.v1.shell_pb2.CopyFilesSourceType viam.gen.service.shell.v1.shell_pb2.ShellRequest viam.gen.service.shell.v1.shell_pb2.ShellResponse viam.gen.service.shell.v1.shell_pb2.FileData viam.gen.service.shell.v1.shell_pb2.CopyFilesToMachineRequestMetadata viam.gen.service.shell.v1.shell_pb2.CopyFilesToMachineRequest viam.gen.service.shell.v1.shell_pb2.CopyFilesToMachineResponse viam.gen.service.shell.v1.shell_pb2.CopyFilesFromMachineRequestMetadata viam.gen.service.shell.v1.shell_pb2.CopyFilesFromMachineRequest viam.gen.service.shell.v1.shell_pb2.CopyFilesFromMachineResponseMetadata viam.gen.service.shell.v1.shell_pb2.CopyFilesFromMachineResponse Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: CopyFilesSourceType Bases: :py:obj:`_CopyFilesSourceType` CopyFilesSourceType indicates what will be copied. It's important to disambiguate the single directory case from the multiple files case in order to indicate that the user's intent is to copy a directory into a single location which may result in a new top-level directory versus the cause of multiples files that always go into the existing target destination. .. py:data:: COPY_FILES_SOURCE_TYPE_UNSPECIFIED :type: CopyFilesSourceType .. py:data:: COPY_FILES_SOURCE_TYPE_SINGLE_FILE :type: CopyFilesSourceType .. py:data:: COPY_FILES_SOURCE_TYPE_SINGLE_DIRECTORY :type: CopyFilesSourceType .. py:data:: COPY_FILES_SOURCE_TYPE_MULTIPLE_FILES :type: CopyFilesSourceType .. py:type:: Global___CopyFilesSourceType :canonical: CopyFilesSourceType .. py:class:: ShellRequest(*, name: str = ..., data_in: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) 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:: name :type: str .. py:attribute:: data_in :type: str .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:type:: Global___ShellRequest :canonical: ShellRequest .. py:class:: ShellResponse(*, data_out: str = ..., data_err: str = ..., eof: bool = ...) 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:: data_out :type: str .. py:attribute:: data_err :type: str .. py:attribute:: eof :type: bool .. py:type:: Global___ShellResponse :canonical: ShellResponse .. py:class:: FileData(*, name: str = ..., size: int = ..., is_dir: bool = ..., data: bytes = ..., eof: bool = ..., mod_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., mode: int | None = ...) Bases: :py:obj:`google.protobuf.message.Message` FileData contains partial (sometimes complete) information about a File. When transmitting FileData with CopyFilesToMachine and CopyFilesFromMachine, it MUST initially contain its name, size, and is_dir. Depending on whether preservation is in use, the mod_time and mode fields may be initially set as well. On all transmissions, data and eof must be set. Because files are sent one-by-one, it is currently permitted to exclude the initially set fields. If this ever changes, a new scheme should be used for identifying files (like a number) in order to reduce data transmission while allowing out-of-order transfers. eof must be true and its own message once no more data is to be sent for this file. .. py:attribute:: name :type: str .. py:attribute:: size :type: int .. py:attribute:: is_dir :type: bool .. py:attribute:: data :type: bytes .. py:attribute:: eof :type: bool .. py:attribute:: mode :type: int .. py:method:: mod_time() -> google.protobuf.timestamp_pb2.Timestamp Note(erd): maybe support access time in the future if needed .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:: WhichOneof(oneof_group: _WhichOneofArgType__mod_time) -> _WhichOneofReturnType__mod_time | None WhichOneof(oneof_group: _WhichOneofArgType__mode) -> _WhichOneofReturnType__mode | None 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:type:: Global___FileData :canonical: FileData .. py:class:: CopyFilesToMachineRequestMetadata(*, name: str = ..., source_type: Global___CopyFilesSourceType = ..., destination: str = ..., preserve: bool = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) 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:: name :type: str name is the service name. .. py:attribute:: source_type :type: Global___CopyFilesSourceType source_type is the type of files that will be transmitted in this request stream. .. py:attribute:: destination :type: str destination is where the files should be placed. The receiver can choose to reasonably modify this destination based on its implementation semantics. .. py:attribute:: preserve :type: bool preserve indicates the the receiver should use the metadata in the file to reflect the same state in its filesystem as applicable. .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:type:: Global___CopyFilesToMachineRequestMetadata :canonical: CopyFilesToMachineRequestMetadata .. py:class:: CopyFilesToMachineRequest(*, metadata: Global___CopyFilesToMachineRequestMetadata | None = ..., file_data: Global___FileData | None = ...) 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:method:: metadata() -> Global___CopyFilesToMachineRequestMetadata metadata is sent first and only once. .. py:method:: file_data() -> Global___FileData file_data is sent only after metadata. All data MUST be sent in order per-file. .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:: WhichOneof(oneof_group: _WhichOneofArgType_request) -> _WhichOneofReturnType_request | None 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:type:: Global___CopyFilesToMachineRequest :canonical: CopyFilesToMachineRequest .. py:class:: CopyFilesToMachineResponse(*, ack_last_file: bool = ...) 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:: ack_last_file :type: bool value does not matter here but responses must be sent after every file has been received. .. py:type:: Global___CopyFilesToMachineResponse :canonical: CopyFilesToMachineResponse .. py:class:: CopyFilesFromMachineRequestMetadata(*, name: str = ..., paths: collections.abc.Iterable[str] | None = ..., allow_recursion: bool = ..., preserve: bool = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) 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:: name :type: str name is the service name. .. py:attribute:: allow_recursion :type: bool allow_recursion indicates if directories should be recursed into. If a directory is encountered and this is false, an error MUST occur. .. py:attribute:: preserve :type: bool preserve indicates the the receiver should provide the metadata in the file to reflect the same state in the sender's filesystem as applicable. .. py:method:: paths() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] paths are the paths to copy from and send back over the wire. .. py:method:: extra() -> google.protobuf.struct_pb2.Struct Additional arguments to the method .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:type:: Global___CopyFilesFromMachineRequestMetadata :canonical: CopyFilesFromMachineRequestMetadata .. py:class:: CopyFilesFromMachineRequest(*, metadata: Global___CopyFilesFromMachineRequestMetadata | None = ..., ack_last_file: bool = ...) 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:: ack_last_file :type: bool ack_last_file is sent only after metadata and after each file has been received. The value does not matter. .. py:method:: metadata() -> Global___CopyFilesFromMachineRequestMetadata metadata is sent first and only once. .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:: WhichOneof(oneof_group: _WhichOneofArgType_request) -> _WhichOneofReturnType_request | None 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:type:: Global___CopyFilesFromMachineRequest :canonical: CopyFilesFromMachineRequest .. py:class:: CopyFilesFromMachineResponseMetadata(*, source_type: Global___CopyFilesSourceType = ...) 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:: source_type :type: Global___CopyFilesSourceType source_type is the type of files that will be transmitted in this response stream. .. py:type:: Global___CopyFilesFromMachineResponseMetadata :canonical: CopyFilesFromMachineResponseMetadata .. py:class:: CopyFilesFromMachineResponse(*, metadata: Global___CopyFilesFromMachineResponseMetadata | None = ..., file_data: Global___FileData | None = ...) 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:method:: metadata() -> Global___CopyFilesFromMachineResponseMetadata metadata is sent first and only once. .. py:method:: file_data() -> Global___FileData file_data is sent only after metadata. All data MUST be sent in order per-file. .. py:method:: HasField(field_name: _HasFieldArgType) -> bool 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:: WhichOneof(oneof_group: _WhichOneofArgType_response) -> _WhichOneofReturnType_response | None 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:type:: Global___CopyFilesFromMachineResponse :canonical: CopyFilesFromMachineResponse