viam.proto.service.discovery
@generated by Viam. Do not edit manually!
Classes
Helper class that provides a standard way to create an ABC using |
|
Helper class that provides a standard way to create an ABC using |
|
Abstract base class for protocol messages. |
|
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.
- abstract DiscoverResources(stream: grpclib.server.Stream[service.discovery.v1.discovery_pb2.DiscoverResourcesRequest, service.discovery.v1.discovery_pb2.DiscoverResourcesResponse]) None [source]
- Async:
- abstract DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) None [source]
- Async:
- class viam.proto.service.discovery.DiscoveryServiceStub(channel: grpclib.client.Channel)[source]
- DiscoverResources
- DoCommand
- 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]
- 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
- property extra: google.protobuf.struct_pb2.Struct
Additional arguments to the method
- 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.discovery.DiscoverResourcesResponse(*, discoveries: collections.abc.Iterable[viam.gen.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.
- property discoveries: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.app.v1.robot_pb2.ComponentConfig]
list of ComponentConfigs that describe the components found by a discover service.