viam.proto.service.discovery

@generated by Viam. Do not edit manually!

Classes

`DiscoveryServiceBase`	Helper class that provides a standard way to create an ABC using
`DiscoveryServiceStub`
`UnimplementedDiscoveryServiceBase`	Helper class that provides a standard way to create an ABC using
`DiscoverResourcesRequest`	Abstract base class for protocol messages.
`DiscoverResourcesResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.service.discovery.DiscoveryServiceBase[source]

Bases: abc.ABC

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

abstractmethod DiscoverResources(stream: grpclib.server.Stream[service.discovery.v1.discovery_pb2.DiscoverResourcesRequest, service.discovery.v1.discovery_pb2.DiscoverResourcesResponse]) → None[source]

Async:

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

Async:

abstractmethod GetStatus(stream: grpclib.server.Stream[common.v1.common_pb2.GetStatusRequest, common.v1.common_pb2.GetStatusResponse]) → None[source]

Async:

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

class viam.proto.service.discovery.DiscoveryServiceStub(channel: grpclib.client.Channel)[source]

DiscoverResources

DoCommand

GetStatus

class viam.proto.service.discovery.UnimplementedDiscoveryServiceBase[source]

Bases: DiscoveryServiceBase

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

async DiscoverResources(stream: grpclib.server.Stream[service.discovery.v1.discovery_pb2.DiscoverResourcesRequest, service.discovery.v1.discovery_pb2.DiscoverResourcesResponse]) → None[source]

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

async GetStatus(stream: grpclib.server.Stream[common.v1.common_pb2.GetStatusRequest, common.v1.common_pb2.GetStatusResponse]) → None[source]

class viam.proto.service.discovery.DiscoverResourcesRequest(*, 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: name of the discover service

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the 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, 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.discovery.DiscoverResourcesResponse(*, discoveries: collections.abc.Iterable[app.v1.robot_pb2.ComponentConfig] | 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.

discoveries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[app.v1.robot_pb2.ComponentConfig]: list of ComponentConfigs that describe the components found by a discover service.