viam.proto.component.button

@generated by Viam. Do not edit manually!

Classes

`ButtonServiceBase`	Helper class that provides a standard way to create an ABC using
`ButtonServiceStub`
`UnimplementedButtonServiceBase`	Helper class that provides a standard way to create an ABC using
`PushRequest`	Abstract base class for protocol messages.
`PushResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.component.button.ButtonServiceBase[source]

Bases: abc.ABC

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

abstract Push(stream: grpclib.server.Stream[component.button.v1.button_pb2.PushRequest, component.button.v1.button_pb2.PushResponse]) → None[source]

Async:

abstract DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.component.button.ButtonServiceStub(channel: grpclib.client.Channel)[source]

Push

DoCommand

class viam.proto.component.button.UnimplementedButtonServiceBase[source]

Bases: ButtonServiceBase

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

async Push(stream: grpclib.server.Stream[component.button.v1.button_pb2.PushRequest, component.button.v1.button_pb2.PushResponse]) → None[source]

async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

class viam.proto.component.button.PushRequest(*, name: 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.

name: str

property extra: google.protobuf.struct_pb2.Struct

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.component.button.PushResponse

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.