viam.proto.service.shell

@generated by Viam. Do not edit manually!

Package Contents

Classes

ShellServiceBase

Helper class that provides a standard way to create an ABC using

ShellServiceStub

ShellRequest

Abstract base class for protocol messages.

ShellResponse

Abstract base class for protocol messages.

class viam.proto.service.shell.ShellServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract async Shell(stream: grpclib.server.Stream[service.shell.v1.shell_pb2.ShellRequest, service.shell.v1.shell_pb2.ShellResponse]) None[source]
abstract async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) None[source]
__mapping__() Dict[str, grpclib.const.Handler][source]
class viam.proto.service.shell.ShellServiceStub(channel: grpclib.client.Channel)[source]
class viam.proto.service.shell.ShellRequest(*, name: str = ..., data_in: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

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.

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

name: str
data_in: str
HasField(field_name: Literal[extra, b'extra']) 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, 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.

class viam.proto.service.shell.ShellResponse(*, data_out: str = ..., data_err: str = ..., eof: bool = ...)

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.

data_out: str
data_err: str
eof: bool