viam.proto.service.worldstatestore

@generated by Viam. Do not edit manually!

Classes

`UnimplementedWorldStateStoreServiceBase`	Helper class that provides a standard way to create an ABC using
`WorldStateStoreServiceBase`	Helper class that provides a standard way to create an ABC using
`WorldStateStoreServiceStub`
`GetTransformRequest`	Abstract base class for protocol messages.
`GetTransformResponse`	Abstract base class for protocol messages.
`ListUUIDsRequest`	Abstract base class for protocol messages.
`ListUUIDsResponse`	Abstract base class for protocol messages.
`StreamTransformChangesRequest`	Abstract base class for protocol messages.
`StreamTransformChangesResponse`	Abstract base class for protocol messages.
`TransformChangeType`

Package Contents

class viam.proto.service.worldstatestore.UnimplementedWorldStateStoreServiceBase[source]

Bases: WorldStateStoreServiceBase

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

async ListUUIDs(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.ListUUIDsRequest, service.worldstatestore.v1.world_state_store_pb2.ListUUIDsResponse]) → None[source]

async GetTransform(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.GetTransformRequest, service.worldstatestore.v1.world_state_store_pb2.GetTransformResponse]) → None[source]

async StreamTransformChanges(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.StreamTransformChangesRequest, service.worldstatestore.v1.world_state_store_pb2.StreamTransformChangesResponse]) → None[source]

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

class viam.proto.service.worldstatestore.WorldStateStoreServiceBase[source]

Bases: abc.ABC

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

abstract ListUUIDs(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.ListUUIDsRequest, service.worldstatestore.v1.world_state_store_pb2.ListUUIDsResponse]) → None[source]

Async:

abstract GetTransform(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.GetTransformRequest, service.worldstatestore.v1.world_state_store_pb2.GetTransformResponse]) → None[source]

Async:

abstract StreamTransformChanges(stream: grpclib.server.Stream[service.worldstatestore.v1.world_state_store_pb2.StreamTransformChangesRequest, service.worldstatestore.v1.world_state_store_pb2.StreamTransformChangesResponse]) → 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.service.worldstatestore.WorldStateStoreServiceStub(channel: grpclib.client.Channel)[source]

ListUUIDs

GetTransform

StreamTransformChanges

DoCommand

class viam.proto.service.worldstatestore.GetTransformRequest(*, name: str = ..., uuid: bytes = ..., 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 world object store service

uuid: bytes

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.worldstatestore.GetTransformResponse(*, transform: viam.gen.common.v1.common_pb2.Transform | 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 transform: viam.gen.common.v1.common_pb2.Transform

HasField(field_name: Literal['transform', b'transform']) → 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.worldstatestore.ListUUIDsRequest(*, 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 world object store 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.worldstatestore.ListUUIDsResponse(*, uuids: collections.abc.Iterable[bytes] | 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 uuids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

class viam.proto.service.worldstatestore.StreamTransformChangesRequest(*, 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 world object store 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.worldstatestore.StreamTransformChangesResponse(*, change_type: global___TransformChangeType = ..., transform: viam.gen.common.v1.common_pb2.Transform | None = ..., updated_fields: google.protobuf.field_mask_pb2.FieldMask | 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.

change_type: global___TransformChangeType

property transform: viam.gen.common.v1.common_pb2.Transform

property updated_fields: google.protobuf.field_mask_pb2.FieldMask: The field mask of the transform that has changed, if any. For added transforms, this will be empty. For updated transforms, this will be the fields that have changed. For removed transforms, this will be the transform’s UUID path.

HasField(field_name: Literal['transform', b'transform', 'updated_fields', b'updated_fields']) → 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.worldstatestore.TransformChangeType: Bases: _TransformChangeType