viam.proto.app

@generated by Viam. Do not edit manually!

Subpackages

Submodules

Classes

AppServiceBase

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

AppServiceStub

UnimplementedAppServiceBase

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

AddRoleRequest

Abstract base class for protocol messages.

AddRoleResponse

Abstract base class for protocol messages.

APIKey

Abstract base class for protocol messages.

APIKeyWithAuthorizations

Abstract base class for protocol messages.

AuthenticationType

AuthenticatorInfo

Abstract base class for protocol messages.

Authorization

Abstract base class for protocol messages.

AuthorizationDetails

Abstract base class for protocol messages.

AuthorizedPermissions

Abstract base class for protocol messages.

ChangeRoleRequest

Abstract base class for protocol messages.

ChangeRoleResponse

Abstract base class for protocol messages.

CheckPermissionsRequest

Abstract base class for protocol messages.

CheckPermissionsResponse

Abstract base class for protocol messages.

CreateFragmentRequest

Abstract base class for protocol messages.

CreateFragmentResponse

Abstract base class for protocol messages.

CreateKeyFromExistingKeyAuthorizationsRequest

Abstract base class for protocol messages.

CreateKeyFromExistingKeyAuthorizationsResponse

Abstract base class for protocol messages.

CreateKeyRequest

Abstract base class for protocol messages.

CreateKeyResponse

Abstract base class for protocol messages.

CreateLocationRequest

Abstract base class for protocol messages.

CreateLocationResponse

Abstract base class for protocol messages.

CreateLocationSecretRequest

Abstract base class for protocol messages.

CreateLocationSecretResponse

Abstract base class for protocol messages.

CreateModuleRequest

Modules

CreateModuleResponse

Abstract base class for protocol messages.

CreateOrganizationInviteRequest

Abstract base class for protocol messages.

CreateOrganizationInviteResponse

Abstract base class for protocol messages.

CreateOrganizationRequest

Abstract base class for protocol messages.

CreateOrganizationResponse

Abstract base class for protocol messages.

CreateRegistryItemRequest

Abstract base class for protocol messages.

CreateRegistryItemResponse

Abstract base class for protocol messages.

CreateRobotPartSecretRequest

Abstract base class for protocol messages.

CreateRobotPartSecretResponse

Abstract base class for protocol messages.

DeleteFragmentRequest

Abstract base class for protocol messages.

DeleteFragmentResponse

Abstract base class for protocol messages.

DeleteKeyRequest

Abstract base class for protocol messages.

DeleteKeyResponse

Abstract base class for protocol messages.

DeleteLocationRequest

Abstract base class for protocol messages.

DeleteLocationResponse

Abstract base class for protocol messages.

DeleteLocationSecretRequest

Abstract base class for protocol messages.

DeleteLocationSecretResponse

Abstract base class for protocol messages.

DeleteOrganizationInviteRequest

Abstract base class for protocol messages.

DeleteOrganizationInviteResponse

Abstract base class for protocol messages.

DeleteOrganizationMemberRequest

Abstract base class for protocol messages.

DeleteOrganizationMemberResponse

Abstract base class for protocol messages.

DeleteOrganizationRequest

Abstract base class for protocol messages.

DeleteOrganizationResponse

Abstract base class for protocol messages.

DeleteRegistryItemRequest

Abstract base class for protocol messages.

DeleteRegistryItemResponse

Abstract base class for protocol messages.

DeleteRobotPartRequest

Abstract base class for protocol messages.

DeleteRobotPartResponse

Abstract base class for protocol messages.

DeleteRobotPartSecretRequest

Abstract base class for protocol messages.

DeleteRobotPartSecretResponse

Abstract base class for protocol messages.

DeleteRobotRequest

Abstract base class for protocol messages.

DeleteRobotResponse

Abstract base class for protocol messages.

Fragment

Abstract base class for protocol messages.

FragmentHistoryEntry

Abstract base class for protocol messages.

FragmentVisibility

GetFragmentHistoryRequest

Abstract base class for protocol messages.

GetFragmentHistoryResponse

Abstract base class for protocol messages.

GetFragmentRequest

Abstract base class for protocol messages.

GetFragmentResponse

Abstract base class for protocol messages.

GetLocationRequest

Abstract base class for protocol messages.

GetLocationResponse

Abstract base class for protocol messages.

GetModuleRequest

Abstract base class for protocol messages.

GetModuleResponse

Abstract base class for protocol messages.

GetOrganizationNamespaceAvailabilityRequest

Abstract base class for protocol messages.

GetOrganizationNamespaceAvailabilityResponse

Abstract base class for protocol messages.

GetOrganizationRequest

Abstract base class for protocol messages.

GetOrganizationResponse

Abstract base class for protocol messages.

GetOrganizationsWithAccessToLocationRequest

Abstract base class for protocol messages.

GetOrganizationsWithAccessToLocationResponse

Abstract base class for protocol messages.

GetRegistryItemRequest

Abstract base class for protocol messages.

GetRegistryItemResponse

Abstract base class for protocol messages.

GetRobotAPIKeysRequest

Abstract base class for protocol messages.

GetRobotAPIKeysResponse

Abstract base class for protocol messages.

GetRobotPartHistoryRequest

Abstract base class for protocol messages.

GetRobotPartHistoryResponse

Abstract base class for protocol messages.

GetRobotPartLogsRequest

Abstract base class for protocol messages.

GetRobotPartLogsResponse

Abstract base class for protocol messages.

GetRobotPartRequest

Abstract base class for protocol messages.

GetRobotPartResponse

Abstract base class for protocol messages.

GetRobotPartsRequest

Abstract base class for protocol messages.

GetRobotPartsResponse

Abstract base class for protocol messages.

GetRobotRequest

Abstract base class for protocol messages.

GetRobotResponse

Abstract base class for protocol messages.

GetRoverRentalRobotsRequest

Abstract base class for protocol messages.

GetRoverRentalRobotsResponse

Abstract base class for protocol messages.

GetUserIDByEmailRequest

Abstract base class for protocol messages.

GetUserIDByEmailResponse

Abstract base class for protocol messages.

ListAuthorizationsRequest

Abstract base class for protocol messages.

ListAuthorizationsResponse

Abstract base class for protocol messages.

ListFragmentsRequest

Abstract base class for protocol messages.

ListFragmentsResponse

Abstract base class for protocol messages.

ListKeysRequest

Abstract base class for protocol messages.

ListKeysResponse

Abstract base class for protocol messages.

ListLocationsRequest

Abstract base class for protocol messages.

ListLocationsResponse

Abstract base class for protocol messages.

ListMachineFragmentsRequest

Abstract base class for protocol messages.

ListMachineFragmentsResponse

Abstract base class for protocol messages.

ListModulesRequest

Abstract base class for protocol messages.

ListModulesResponse

Abstract base class for protocol messages.

ListOrganizationMembersRequest

Abstract base class for protocol messages.

ListOrganizationMembersResponse

Abstract base class for protocol messages.

ListOrganizationsByUserRequest

Abstract base class for protocol messages.

ListOrganizationsByUserResponse

Abstract base class for protocol messages.

ListOrganizationsRequest

Abstract base class for protocol messages.

ListOrganizationsResponse

Abstract base class for protocol messages.

ListRegistryItemsRequest

Abstract base class for protocol messages.

ListRegistryItemsResponse

Abstract base class for protocol messages.

ListRobotsRequest

Abstract base class for protocol messages.

ListRobotsResponse

Abstract base class for protocol messages.

Location

Abstract base class for protocol messages.

LocationAuth

Abstract base class for protocol messages.

LocationAuthRequest

Abstract base class for protocol messages.

LocationAuthResponse

Abstract base class for protocol messages.

LocationOrganization

Abstract base class for protocol messages.

MarkPartAsMainRequest

Abstract base class for protocol messages.

MarkPartAsMainResponse

Abstract base class for protocol messages.

MarkPartForRestartRequest

Abstract base class for protocol messages.

MarkPartForRestartResponse

Abstract base class for protocol messages.

MLModelMetadata

Abstract base class for protocol messages.

MLTrainingMetadata

Abstract base class for protocol messages.

MLTrainingVersion

Abstract base class for protocol messages.

Model

Abstract base class for protocol messages.

Module

Abstract base class for protocol messages.

ModuleFileInfo

Abstract base class for protocol messages.

ModuleMetadata

Abstract base class for protocol messages.

ModuleVersion

Abstract base class for protocol messages.

NewRobotPartRequest

Abstract base class for protocol messages.

NewRobotPartResponse

Abstract base class for protocol messages.

NewRobotRequest

Abstract base class for protocol messages.

NewRobotResponse

Abstract base class for protocol messages.

Organization

Abstract base class for protocol messages.

OrganizationIdentity

Location

OrganizationInvite

Abstract base class for protocol messages.

OrganizationMember

Abstract base class for protocol messages.

OrgDetails

Abstract base class for protocol messages.

RegistryItem

Abstract base class for protocol messages.

RegistryItemStatus

RemoveRoleRequest

Abstract base class for protocol messages.

RemoveRoleResponse

Abstract base class for protocol messages.

RenameKeyRequest

Abstract base class for protocol messages.

RenameKeyResponse

Abstract base class for protocol messages.

ResendOrganizationInviteRequest

Abstract base class for protocol messages.

ResendOrganizationInviteResponse

Abstract base class for protocol messages.

Robot

Abstract base class for protocol messages.

RobotPart

Abstract base class for protocol messages.

RobotPartHistoryEntry

Abstract base class for protocol messages.

RotateKeyRequest

Abstract base class for protocol messages.

RotateKeyResponse

Abstract base class for protocol messages.

RoverRentalRobot

Abstract base class for protocol messages.

SharedSecret

SharedSecret is a secret used for LocationAuth and RobotParts.

ShareLocationRequest

Abstract base class for protocol messages.

ShareLocationResponse

Abstract base class for protocol messages.

StorageConfig

Abstract base class for protocol messages.

TailRobotPartLogsRequest

Abstract base class for protocol messages.

TailRobotPartLogsResponse

Abstract base class for protocol messages.

TransferRegistryItemRequest

Abstract base class for protocol messages.

TransferRegistryItemResponse

Abstract base class for protocol messages.

UnshareLocationRequest

Abstract base class for protocol messages.

UnshareLocationResponse

Abstract base class for protocol messages.

UpdateFragmentRequest

Abstract base class for protocol messages.

UpdateFragmentResponse

Abstract base class for protocol messages.

UpdateLocationRequest

Abstract base class for protocol messages.

UpdateLocationResponse

Abstract base class for protocol messages.

UpdateModuleRequest

Abstract base class for protocol messages.

UpdateModuleResponse

Abstract base class for protocol messages.

UpdateOrganizationInviteAuthorizationsRequest

Abstract base class for protocol messages.

UpdateOrganizationInviteAuthorizationsResponse

Abstract base class for protocol messages.

UpdateOrganizationRequest

Abstract base class for protocol messages.

UpdateOrganizationResponse

Abstract base class for protocol messages.

UpdateRegistryItemRequest

Abstract base class for protocol messages.

UpdateRegistryItemResponse

Abstract base class for protocol messages.

UpdateRobotPartRequest

Abstract base class for protocol messages.

UpdateRobotPartResponse

Abstract base class for protocol messages.

UpdateRobotRequest

Abstract base class for protocol messages.

UpdateRobotResponse

Abstract base class for protocol messages.

UploadModuleFileRequest

Abstract base class for protocol messages.

UploadModuleFileResponse

Abstract base class for protocol messages.

Uploads

Abstract base class for protocol messages.

VersionHistory

Abstract base class for protocol messages.

Visibility

Package Contents

class viam.proto.app.AppServiceBase[source]

Bases: abc.ABC

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

abstract GetUserIDByEmail(stream: grpclib.server.Stream[app.v1.app_pb2.GetUserIDByEmailRequest, app.v1.app_pb2.GetUserIDByEmailResponse]) None[source]
Async:

abstract CreateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationRequest, app.v1.app_pb2.CreateOrganizationResponse]) None[source]
Async:

abstract ListOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsRequest, app.v1.app_pb2.ListOrganizationsResponse]) None[source]
Async:

abstract GetOrganizationsWithAccessToLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationsWithAccessToLocationRequest, app.v1.app_pb2.GetOrganizationsWithAccessToLocationResponse]) None[source]
Async:

abstract ListOrganizationsByUser(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsByUserRequest, app.v1.app_pb2.ListOrganizationsByUserResponse]) None[source]
Async:

abstract GetOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationRequest, app.v1.app_pb2.GetOrganizationResponse]) None[source]
Async:

abstract GetOrganizationNamespaceAvailability(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationNamespaceAvailabilityRequest, app.v1.app_pb2.GetOrganizationNamespaceAvailabilityResponse]) None[source]
Async:

abstract UpdateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationRequest, app.v1.app_pb2.UpdateOrganizationResponse]) None[source]
Async:

abstract DeleteOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationRequest, app.v1.app_pb2.DeleteOrganizationResponse]) None[source]
Async:

abstract ListOrganizationMembers(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationMembersRequest, app.v1.app_pb2.ListOrganizationMembersResponse]) None[source]
Async:

abstract CreateOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationInviteRequest, app.v1.app_pb2.CreateOrganizationInviteResponse]) None[source]
Async:

abstract UpdateOrganizationInviteAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsRequest, app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsResponse]) None[source]
Async:

abstract DeleteOrganizationMember(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationMemberRequest, app.v1.app_pb2.DeleteOrganizationMemberResponse]) None[source]
Async:

abstract DeleteOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationInviteRequest, app.v1.app_pb2.DeleteOrganizationInviteResponse]) None[source]
Async:

abstract ResendOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.ResendOrganizationInviteRequest, app.v1.app_pb2.ResendOrganizationInviteResponse]) None[source]
Async:

abstract CreateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationRequest, app.v1.app_pb2.CreateLocationResponse]) None[source]
Async:

abstract GetLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationRequest, app.v1.app_pb2.GetLocationResponse]) None[source]
Async:

abstract UpdateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationRequest, app.v1.app_pb2.UpdateLocationResponse]) None[source]
Async:

abstract DeleteLocation(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationRequest, app.v1.app_pb2.DeleteLocationResponse]) None[source]
Async:

abstract ListLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListLocationsRequest, app.v1.app_pb2.ListLocationsResponse]) None[source]
Async:

abstract ShareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.ShareLocationRequest, app.v1.app_pb2.ShareLocationResponse]) None[source]
Async:

abstract UnshareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UnshareLocationRequest, app.v1.app_pb2.UnshareLocationResponse]) None[source]
Async:

abstract LocationAuth(stream: grpclib.server.Stream[app.v1.app_pb2.LocationAuthRequest, app.v1.app_pb2.LocationAuthResponse]) None[source]
Async:

abstract CreateLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationSecretRequest, app.v1.app_pb2.CreateLocationSecretResponse]) None[source]
Async:

abstract DeleteLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationSecretRequest, app.v1.app_pb2.DeleteLocationSecretResponse]) None[source]
Async:

abstract GetRobot(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotRequest, app.v1.app_pb2.GetRobotResponse]) None[source]
Async:

abstract GetRoverRentalRobots(stream: grpclib.server.Stream[app.v1.app_pb2.GetRoverRentalRobotsRequest, app.v1.app_pb2.GetRoverRentalRobotsResponse]) None[source]
Async:

abstract GetRobotParts(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartsRequest, app.v1.app_pb2.GetRobotPartsResponse]) None[source]
Async:

abstract GetRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartRequest, app.v1.app_pb2.GetRobotPartResponse]) None[source]
Async:

abstract GetRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartLogsRequest, app.v1.app_pb2.GetRobotPartLogsResponse]) None[source]
Async:

abstract TailRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.TailRobotPartLogsRequest, app.v1.app_pb2.TailRobotPartLogsResponse]) None[source]
Async:

abstract GetRobotPartHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartHistoryRequest, app.v1.app_pb2.GetRobotPartHistoryResponse]) None[source]
Async:

abstract UpdateRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartRequest, app.v1.app_pb2.UpdateRobotPartResponse]) None[source]
Async:

abstract NewRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotPartRequest, app.v1.app_pb2.NewRobotPartResponse]) None[source]
Async:

abstract DeleteRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartRequest, app.v1.app_pb2.DeleteRobotPartResponse]) None[source]
Async:

abstract GetRobotAPIKeys(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotAPIKeysRequest, app.v1.app_pb2.GetRobotAPIKeysResponse]) None[source]
Async:

abstract MarkPartAsMain(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartAsMainRequest, app.v1.app_pb2.MarkPartAsMainResponse]) None[source]
Async:

abstract MarkPartForRestart(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartForRestartRequest, app.v1.app_pb2.MarkPartForRestartResponse]) None[source]
Async:

abstract CreateRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRobotPartSecretRequest, app.v1.app_pb2.CreateRobotPartSecretResponse]) None[source]
Async:

abstract DeleteRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartSecretRequest, app.v1.app_pb2.DeleteRobotPartSecretResponse]) None[source]
Async:

abstract ListRobots(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsRequest, app.v1.app_pb2.ListRobotsResponse]) None[source]
Async:

abstract NewRobot(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotRequest, app.v1.app_pb2.NewRobotResponse]) None[source]
Async:

abstract UpdateRobot(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotRequest, app.v1.app_pb2.UpdateRobotResponse]) None[source]
Async:

abstract DeleteRobot(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotRequest, app.v1.app_pb2.DeleteRobotResponse]) None[source]
Async:

abstract ListFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListFragmentsRequest, app.v1.app_pb2.ListFragmentsResponse]) None[source]
Async:

abstract GetFragment(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentRequest, app.v1.app_pb2.GetFragmentResponse]) None[source]
Async:

abstract CreateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.CreateFragmentRequest, app.v1.app_pb2.CreateFragmentResponse]) None[source]
Async:

abstract UpdateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateFragmentRequest, app.v1.app_pb2.UpdateFragmentResponse]) None[source]
Async:

abstract DeleteFragment(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentRequest, app.v1.app_pb2.DeleteFragmentResponse]) None[source]
Async:

abstract ListMachineFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineFragmentsRequest, app.v1.app_pb2.ListMachineFragmentsResponse]) None[source]
Async:

abstract GetFragmentHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentHistoryRequest, app.v1.app_pb2.GetFragmentHistoryResponse]) None[source]
Async:

abstract AddRole(stream: grpclib.server.Stream[app.v1.app_pb2.AddRoleRequest, app.v1.app_pb2.AddRoleResponse]) None[source]
Async:

abstract RemoveRole(stream: grpclib.server.Stream[app.v1.app_pb2.RemoveRoleRequest, app.v1.app_pb2.RemoveRoleResponse]) None[source]
Async:

abstract ChangeRole(stream: grpclib.server.Stream[app.v1.app_pb2.ChangeRoleRequest, app.v1.app_pb2.ChangeRoleResponse]) None[source]
Async:

abstract ListAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListAuthorizationsRequest, app.v1.app_pb2.ListAuthorizationsResponse]) None[source]
Async:

abstract CheckPermissions(stream: grpclib.server.Stream[app.v1.app_pb2.CheckPermissionsRequest, app.v1.app_pb2.CheckPermissionsResponse]) None[source]
Async:

abstract GetRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.GetRegistryItemRequest, app.v1.app_pb2.GetRegistryItemResponse]) None[source]
Async:

abstract CreateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRegistryItemRequest, app.v1.app_pb2.CreateRegistryItemResponse]) None[source]
Async:

abstract UpdateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRegistryItemRequest, app.v1.app_pb2.UpdateRegistryItemResponse]) None[source]
Async:

abstract ListRegistryItems(stream: grpclib.server.Stream[app.v1.app_pb2.ListRegistryItemsRequest, app.v1.app_pb2.ListRegistryItemsResponse]) None[source]
Async:

abstract DeleteRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRegistryItemRequest, app.v1.app_pb2.DeleteRegistryItemResponse]) None[source]
Async:

abstract TransferRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.TransferRegistryItemRequest, app.v1.app_pb2.TransferRegistryItemResponse]) None[source]
Async:

abstract CreateModule(stream: grpclib.server.Stream[app.v1.app_pb2.CreateModuleRequest, app.v1.app_pb2.CreateModuleResponse]) None[source]
Async:

abstract UpdateModule(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateModuleRequest, app.v1.app_pb2.UpdateModuleResponse]) None[source]
Async:

abstract UploadModuleFile(stream: grpclib.server.Stream[app.v1.app_pb2.UploadModuleFileRequest, app.v1.app_pb2.UploadModuleFileResponse]) None[source]
Async:

abstract GetModule(stream: grpclib.server.Stream[app.v1.app_pb2.GetModuleRequest, app.v1.app_pb2.GetModuleResponse]) None[source]
Async:

abstract ListModules(stream: grpclib.server.Stream[app.v1.app_pb2.ListModulesRequest, app.v1.app_pb2.ListModulesResponse]) None[source]
Async:

abstract CreateKey(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyRequest, app.v1.app_pb2.CreateKeyResponse]) None[source]
Async:

abstract DeleteKey(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteKeyRequest, app.v1.app_pb2.DeleteKeyResponse]) None[source]
Async:

abstract ListKeys(stream: grpclib.server.Stream[app.v1.app_pb2.ListKeysRequest, app.v1.app_pb2.ListKeysResponse]) None[source]
Async:

abstract RenameKey(stream: grpclib.server.Stream[app.v1.app_pb2.RenameKeyRequest, app.v1.app_pb2.RenameKeyResponse]) None[source]
Async:

abstract RotateKey(stream: grpclib.server.Stream[app.v1.app_pb2.RotateKeyRequest, app.v1.app_pb2.RotateKeyResponse]) None[source]
Async:

abstract CreateKeyFromExistingKeyAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsRequest, app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsResponse]) None[source]
Async:

__mapping__() Dict[str, grpclib.const.Handler][source]
class viam.proto.app.AppServiceStub(channel: grpclib.client.Channel)[source]
class viam.proto.app.UnimplementedAppServiceBase[source]

Bases: AppServiceBase

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

async GetUserIDByEmail(stream: grpclib.server.Stream[app.v1.app_pb2.GetUserIDByEmailRequest, app.v1.app_pb2.GetUserIDByEmailResponse]) None[source]
async CreateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationRequest, app.v1.app_pb2.CreateOrganizationResponse]) None[source]
async ListOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsRequest, app.v1.app_pb2.ListOrganizationsResponse]) None[source]
async GetOrganizationsWithAccessToLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationsWithAccessToLocationRequest, app.v1.app_pb2.GetOrganizationsWithAccessToLocationResponse]) None[source]
async ListOrganizationsByUser(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsByUserRequest, app.v1.app_pb2.ListOrganizationsByUserResponse]) None[source]
async GetOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationRequest, app.v1.app_pb2.GetOrganizationResponse]) None[source]
async GetOrganizationNamespaceAvailability(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationNamespaceAvailabilityRequest, app.v1.app_pb2.GetOrganizationNamespaceAvailabilityResponse]) None[source]
async UpdateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationRequest, app.v1.app_pb2.UpdateOrganizationResponse]) None[source]
async DeleteOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationRequest, app.v1.app_pb2.DeleteOrganizationResponse]) None[source]
async ListOrganizationMembers(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationMembersRequest, app.v1.app_pb2.ListOrganizationMembersResponse]) None[source]
async CreateOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationInviteRequest, app.v1.app_pb2.CreateOrganizationInviteResponse]) None[source]
async UpdateOrganizationInviteAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsRequest, app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsResponse]) None[source]
async DeleteOrganizationMember(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationMemberRequest, app.v1.app_pb2.DeleteOrganizationMemberResponse]) None[source]
async DeleteOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationInviteRequest, app.v1.app_pb2.DeleteOrganizationInviteResponse]) None[source]
async ResendOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.ResendOrganizationInviteRequest, app.v1.app_pb2.ResendOrganizationInviteResponse]) None[source]
async CreateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationRequest, app.v1.app_pb2.CreateLocationResponse]) None[source]
async GetLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationRequest, app.v1.app_pb2.GetLocationResponse]) None[source]
async UpdateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationRequest, app.v1.app_pb2.UpdateLocationResponse]) None[source]
async DeleteLocation(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationRequest, app.v1.app_pb2.DeleteLocationResponse]) None[source]
async ListLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListLocationsRequest, app.v1.app_pb2.ListLocationsResponse]) None[source]
async ShareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.ShareLocationRequest, app.v1.app_pb2.ShareLocationResponse]) None[source]
async UnshareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UnshareLocationRequest, app.v1.app_pb2.UnshareLocationResponse]) None[source]
async LocationAuth(stream: grpclib.server.Stream[app.v1.app_pb2.LocationAuthRequest, app.v1.app_pb2.LocationAuthResponse]) None[source]
async CreateLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationSecretRequest, app.v1.app_pb2.CreateLocationSecretResponse]) None[source]
async DeleteLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationSecretRequest, app.v1.app_pb2.DeleteLocationSecretResponse]) None[source]
async GetRobot(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotRequest, app.v1.app_pb2.GetRobotResponse]) None[source]
async GetRoverRentalRobots(stream: grpclib.server.Stream[app.v1.app_pb2.GetRoverRentalRobotsRequest, app.v1.app_pb2.GetRoverRentalRobotsResponse]) None[source]
async GetRobotParts(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartsRequest, app.v1.app_pb2.GetRobotPartsResponse]) None[source]
async GetRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartRequest, app.v1.app_pb2.GetRobotPartResponse]) None[source]
async GetRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartLogsRequest, app.v1.app_pb2.GetRobotPartLogsResponse]) None[source]
async TailRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.TailRobotPartLogsRequest, app.v1.app_pb2.TailRobotPartLogsResponse]) None[source]
async GetRobotPartHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartHistoryRequest, app.v1.app_pb2.GetRobotPartHistoryResponse]) None[source]
async UpdateRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartRequest, app.v1.app_pb2.UpdateRobotPartResponse]) None[source]
async NewRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotPartRequest, app.v1.app_pb2.NewRobotPartResponse]) None[source]
async DeleteRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartRequest, app.v1.app_pb2.DeleteRobotPartResponse]) None[source]
async GetRobotAPIKeys(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotAPIKeysRequest, app.v1.app_pb2.GetRobotAPIKeysResponse]) None[source]
async MarkPartAsMain(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartAsMainRequest, app.v1.app_pb2.MarkPartAsMainResponse]) None[source]
async MarkPartForRestart(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartForRestartRequest, app.v1.app_pb2.MarkPartForRestartResponse]) None[source]
async CreateRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRobotPartSecretRequest, app.v1.app_pb2.CreateRobotPartSecretResponse]) None[source]
async DeleteRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartSecretRequest, app.v1.app_pb2.DeleteRobotPartSecretResponse]) None[source]
async ListRobots(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsRequest, app.v1.app_pb2.ListRobotsResponse]) None[source]
async NewRobot(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotRequest, app.v1.app_pb2.NewRobotResponse]) None[source]
async UpdateRobot(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotRequest, app.v1.app_pb2.UpdateRobotResponse]) None[source]
async DeleteRobot(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotRequest, app.v1.app_pb2.DeleteRobotResponse]) None[source]
async ListFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListFragmentsRequest, app.v1.app_pb2.ListFragmentsResponse]) None[source]
async GetFragment(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentRequest, app.v1.app_pb2.GetFragmentResponse]) None[source]
async CreateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.CreateFragmentRequest, app.v1.app_pb2.CreateFragmentResponse]) None[source]
async UpdateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateFragmentRequest, app.v1.app_pb2.UpdateFragmentResponse]) None[source]
async DeleteFragment(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentRequest, app.v1.app_pb2.DeleteFragmentResponse]) None[source]
async ListMachineFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineFragmentsRequest, app.v1.app_pb2.ListMachineFragmentsResponse]) None[source]
async GetFragmentHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentHistoryRequest, app.v1.app_pb2.GetFragmentHistoryResponse]) None[source]
async AddRole(stream: grpclib.server.Stream[app.v1.app_pb2.AddRoleRequest, app.v1.app_pb2.AddRoleResponse]) None[source]
async RemoveRole(stream: grpclib.server.Stream[app.v1.app_pb2.RemoveRoleRequest, app.v1.app_pb2.RemoveRoleResponse]) None[source]
async ChangeRole(stream: grpclib.server.Stream[app.v1.app_pb2.ChangeRoleRequest, app.v1.app_pb2.ChangeRoleResponse]) None[source]
async ListAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListAuthorizationsRequest, app.v1.app_pb2.ListAuthorizationsResponse]) None[source]
async CheckPermissions(stream: grpclib.server.Stream[app.v1.app_pb2.CheckPermissionsRequest, app.v1.app_pb2.CheckPermissionsResponse]) None[source]
async GetRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.GetRegistryItemRequest, app.v1.app_pb2.GetRegistryItemResponse]) None[source]
async CreateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRegistryItemRequest, app.v1.app_pb2.CreateRegistryItemResponse]) None[source]
async UpdateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRegistryItemRequest, app.v1.app_pb2.UpdateRegistryItemResponse]) None[source]
async ListRegistryItems(stream: grpclib.server.Stream[app.v1.app_pb2.ListRegistryItemsRequest, app.v1.app_pb2.ListRegistryItemsResponse]) None[source]
async DeleteRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRegistryItemRequest, app.v1.app_pb2.DeleteRegistryItemResponse]) None[source]
async TransferRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.TransferRegistryItemRequest, app.v1.app_pb2.TransferRegistryItemResponse]) None[source]
async CreateModule(stream: grpclib.server.Stream[app.v1.app_pb2.CreateModuleRequest, app.v1.app_pb2.CreateModuleResponse]) None[source]
async UpdateModule(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateModuleRequest, app.v1.app_pb2.UpdateModuleResponse]) None[source]
async UploadModuleFile(stream: grpclib.server.Stream[app.v1.app_pb2.UploadModuleFileRequest, app.v1.app_pb2.UploadModuleFileResponse]) None[source]
async GetModule(stream: grpclib.server.Stream[app.v1.app_pb2.GetModuleRequest, app.v1.app_pb2.GetModuleResponse]) None[source]
async ListModules(stream: grpclib.server.Stream[app.v1.app_pb2.ListModulesRequest, app.v1.app_pb2.ListModulesResponse]) None[source]
async CreateKey(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyRequest, app.v1.app_pb2.CreateKeyResponse]) None[source]
async DeleteKey(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteKeyRequest, app.v1.app_pb2.DeleteKeyResponse]) None[source]
async ListKeys(stream: grpclib.server.Stream[app.v1.app_pb2.ListKeysRequest, app.v1.app_pb2.ListKeysResponse]) None[source]
async RenameKey(stream: grpclib.server.Stream[app.v1.app_pb2.RenameKeyRequest, app.v1.app_pb2.RenameKeyResponse]) None[source]
async RotateKey(stream: grpclib.server.Stream[app.v1.app_pb2.RotateKeyRequest, app.v1.app_pb2.RotateKeyResponse]) None[source]
async CreateKeyFromExistingKeyAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsRequest, app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsResponse]) None[source]
class viam.proto.app.AddRoleRequest(*, authorization: global___Authorization | 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 authorization: global___Authorization
HasField(field_name: Literal['authorization', b'authorization']) 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.app.AddRoleResponse

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.

class viam.proto.app.APIKey(*, id: str = ..., key: str = ..., name: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | 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.

id: str
key: str
name: str
property created_on: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['created_on', b'created_on']) 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.app.APIKeyWithAuthorizations(*, api_key: global___APIKey | None = ..., authorizations: collections.abc.Iterable[global___AuthorizationDetails] | 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 api_key: global___APIKey
property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizationDetails]
HasField(field_name: Literal['api_key', b'api_key']) 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.app.AuthenticationType

Bases: _AuthenticationType

class viam.proto.app.AuthenticatorInfo(*, type: global___AuthenticationType = ..., value: str = ..., is_deactivated: 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.

type: global___AuthenticationType
value: str
is_deactivated: bool
class viam.proto.app.Authorization(*, authorization_type: str = ..., authorization_id: str = ..., resource_type: str = ..., resource_id: str = ..., identity_id: str = ..., organization_id: str = ..., identity_type: str = ...)

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.

authorization_type: str
authorization_id: str
resource_type: str
resource_id: str
identity_id: str
organization_id: str
identity_type: str
class viam.proto.app.AuthorizationDetails(*, authorization_type: str = ..., authorization_id: str = ..., resource_type: str = ..., resource_id: str = ..., org_id: str = ...)

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.

authorization_type: str
authorization_id: str
resource_type: str
resource_id: str
org_id: str
class viam.proto.app.AuthorizedPermissions(*, resource_type: str = ..., resource_id: str = ..., permissions: collections.abc.Iterable[str] | 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.

resource_type: str
resource_id: str
property permissions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
class viam.proto.app.ChangeRoleRequest(*, old_authorization: global___Authorization | None = ..., new_authorization: global___Authorization | 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 old_authorization: global___Authorization
property new_authorization: global___Authorization
HasField(field_name: Literal['new_authorization', b'new_authorization', 'old_authorization', b'old_authorization']) 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.app.ChangeRoleResponse

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.

class viam.proto.app.CheckPermissionsRequest(*, permissions: collections.abc.Iterable[global___AuthorizedPermissions] | 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 permissions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizedPermissions]
class viam.proto.app.CheckPermissionsResponse(*, authorized_permissions: collections.abc.Iterable[global___AuthorizedPermissions] | 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 authorized_permissions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizedPermissions]
class viam.proto.app.CreateFragmentRequest(*, name: str = ..., config: google.protobuf.struct_pb2.Struct | None = ..., organization_id: str = ...)

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
organization_id: str
property config: google.protobuf.struct_pb2.Struct
HasField(field_name: Literal['config', b'config']) 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.app.CreateFragmentResponse(*, fragment: global___Fragment | 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 fragment: global___Fragment
HasField(field_name: Literal['fragment', b'fragment']) 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.app.CreateKeyFromExistingKeyAuthorizationsRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.CreateKeyFromExistingKeyAuthorizationsResponse(*, id: str = ..., key: str = ...)

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.

id: str
key: str
class viam.proto.app.CreateKeyRequest(*, authorizations: collections.abc.Iterable[global___Authorization] | None = ..., name: str = ...)

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 authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
class viam.proto.app.CreateKeyResponse(*, key: str = ..., id: str = ...)

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.

key: str
id: str
class viam.proto.app.CreateLocationRequest(*, organization_id: str = ..., name: str = ..., parent_location_id: str | 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.

organization_id: str

Organization ID to create the location under.

name: str

Name of the location.

parent_location_id: str

The new parent location to move the location under.

HasField(field_name: Literal['_parent_location_id', b'_parent_location_id', 'parent_location_id', b'parent_location_id']) 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.

WhichOneof(oneof_group: Literal['_parent_location_id', b'_parent_location_id']) Literal['parent_location_id'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.CreateLocationResponse(*, location: global___Location | 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 location: global___Location

Location object is returned.

HasField(field_name: Literal['location', b'location']) 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.app.CreateLocationSecretRequest(*, location_id: str = ...)

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.

location_id: str

Location ID to create the secret in.

class viam.proto.app.CreateLocationSecretResponse(*, auth: global___LocationAuth | 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 auth: global___LocationAuth

Location’s auth after updates.

HasField(field_name: Literal['auth', b'auth']) 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.app.CreateModuleRequest(*, organization_id: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Modules

organization_id: str

The organization to create the module under

name: str

The name of the module, which must be unique within your org

class viam.proto.app.CreateModuleResponse(*, module_id: str = ..., url: str = ...)

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.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:

The id of the module (formatted as prefix

url: str

The detail page of the module

class viam.proto.app.CreateOrganizationInviteRequest(*, organization_id: str = ..., email: str = ..., authorizations: collections.abc.Iterable[global___Authorization] | None = ..., send_email_invite: bool | 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.

organization_id: str
email: str
send_email_invite: bool

Set to true (the default) to send an email to the recipient of an invite. The user must accept the email to be added to the associated authorizations. When set to false, the user automatically receives the associated authorization on the next login of the user with the associated email address.

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
HasField(field_name: Literal['_send_email_invite', b'_send_email_invite', 'send_email_invite', b'send_email_invite']) 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.

WhichOneof(oneof_group: Literal['_send_email_invite', b'_send_email_invite']) Literal['send_email_invite'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.CreateOrganizationInviteResponse(*, invite: global___OrganizationInvite | 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 invite: global___OrganizationInvite
HasField(field_name: Literal['invite', b'invite']) 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.app.CreateOrganizationRequest(*, name: str = ...)

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
class viam.proto.app.CreateOrganizationResponse(*, organization: global___Organization | 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 organization: global___Organization
HasField(field_name: Literal['organization', b'organization']) 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.app.CreateRegistryItemRequest(*, organization_id: str = ..., name: str = ..., type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType = ...)

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.

organization_id: str

The organization to create the registry item under

name: str

The name of the registry item, which must be unique within your org

type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType

The type of the item in the registry

class viam.proto.app.CreateRegistryItemResponse

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.

class viam.proto.app.CreateRobotPartSecretRequest(*, part_id: str = ...)

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.

part_id: str

Robot Part ID to create the secret in.

class viam.proto.app.CreateRobotPartSecretResponse(*, part: global___RobotPart | 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 part: global___RobotPart

Location’s auth after updates.

HasField(field_name: Literal['part', b'part']) 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.app.DeleteFragmentRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.DeleteFragmentResponse

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.

class viam.proto.app.DeleteKeyRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.DeleteKeyResponse

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.

class viam.proto.app.DeleteLocationRequest(*, location_id: str = ...)

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.

location_id: str

Location ID of location to delete.

class viam.proto.app.DeleteLocationResponse

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.

class viam.proto.app.DeleteLocationSecretRequest(*, location_id: str = ..., secret_id: str = ...)

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.

location_id: str
secret_id: str
class viam.proto.app.DeleteLocationSecretResponse

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.

class viam.proto.app.DeleteOrganizationInviteRequest(*, organization_id: str = ..., email: str = ...)

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.

organization_id: str
email: str
class viam.proto.app.DeleteOrganizationInviteResponse

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.

class viam.proto.app.DeleteOrganizationMemberRequest(*, organization_id: str = ..., user_id: str = ...)

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.

organization_id: str
user_id: str
class viam.proto.app.DeleteOrganizationMemberResponse

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.

class viam.proto.app.DeleteOrganizationRequest(*, organization_id: str = ...)

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.

organization_id: str
class viam.proto.app.DeleteOrganizationResponse

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.

class viam.proto.app.DeleteRegistryItemRequest(*, item_id: str = ...)

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.

item_id: str

name where prefix is the owner’s orgid or namespace)

Type:

The id of the item (formatted as prefix

class viam.proto.app.DeleteRegistryItemResponse

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.

class viam.proto.app.DeleteRobotPartRequest(*, part_id: str = ...)

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.

part_id: str
class viam.proto.app.DeleteRobotPartResponse

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.

class viam.proto.app.DeleteRobotPartSecretRequest(*, part_id: str = ..., secret_id: str = ...)

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.

part_id: str
secret_id: str
class viam.proto.app.DeleteRobotPartSecretResponse

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.

class viam.proto.app.DeleteRobotRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.DeleteRobotResponse

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.

class viam.proto.app.Fragment(*, id: str = ..., name: str = ..., fragment: google.protobuf.struct_pb2.Struct | None = ..., organization_owner: str = ..., public: bool = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., organization_name: str = ..., robot_part_count: int = ..., organization_count: int = ..., only_used_by_owner: bool = ..., visibility: global___FragmentVisibility = ...)

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.

id: str
name: str
organization_owner: str
public: bool
organization_name: str
robot_part_count: int

number of robot parts using this fragment

organization_count: int

number of organizations using this fragment

only_used_by_owner: bool

whether the organization(s) using this fragment is the same as the fragment org

visibility: global___FragmentVisibility

the visibility of a fragment; public, private or unlisted

property fragment: google.protobuf.struct_pb2.Struct
property created_on: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['created_on', b'created_on', 'fragment', b'fragment']) 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.app.FragmentHistoryEntry(*, fragment: str = ..., edited_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., old: global___Fragment | None = ..., edited_by: global___AuthenticatorInfo | 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.

fragment: str
property edited_on: google.protobuf.timestamp_pb2.Timestamp
property old: global___Fragment
property edited_by: global___AuthenticatorInfo
HasField(field_name: Literal['edited_by', b'edited_by', 'edited_on', b'edited_on', 'old', b'old']) 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.app.FragmentVisibility

Bases: _FragmentVisibility

class viam.proto.app.GetFragmentHistoryRequest(*, id: str = ..., page_token: str | None = ..., page_limit: int | 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.

id: str
page_token: str
page_limit: int
HasField(field_name: Literal['_page_limit', b'_page_limit', '_page_token', b'_page_token', 'page_limit', b'page_limit', 'page_token', b'page_token']) 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.

WhichOneof(oneof_group: Literal['_page_limit', b'_page_limit']) Literal['page_limit'] | None
WhichOneof(oneof_group: Literal['_page_token', b'_page_token']) Literal['page_token'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.GetFragmentHistoryResponse(*, history: collections.abc.Iterable[global___FragmentHistoryEntry] | None = ..., next_page_token: str = ...)

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.

next_page_token: str
property history: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FragmentHistoryEntry]
class viam.proto.app.GetFragmentRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.GetFragmentResponse(*, fragment: global___Fragment | 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 fragment: global___Fragment
HasField(field_name: Literal['fragment', b'fragment']) 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.app.GetLocationRequest(*, location_id: str = ...)

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.

location_id: str

Location ID of location to get.

class viam.proto.app.GetLocationResponse(*, location: global___Location | 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 location: global___Location

Location object is returned.

HasField(field_name: Literal['location', b'location']) 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.app.GetModuleRequest(*, module_id: str = ...)

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.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:

The id of the module (formatted as prefix

class viam.proto.app.GetModuleResponse(*, module: global___Module | 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 module: global___Module

The module object

HasField(field_name: Literal['module', b'module']) 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.app.GetOrganizationNamespaceAvailabilityRequest(*, public_namespace: str = ...)

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.

public_namespace: str
class viam.proto.app.GetOrganizationNamespaceAvailabilityResponse(*, available: 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.

available: bool
class viam.proto.app.GetOrganizationRequest(*, organization_id: str = ...)

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.

organization_id: str
class viam.proto.app.GetOrganizationResponse(*, organization: global___Organization | 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 organization: global___Organization
HasField(field_name: Literal['organization', b'organization']) 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.app.GetOrganizationsWithAccessToLocationRequest(*, location_id: str = ...)

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.

location_id: str
class viam.proto.app.GetOrganizationsWithAccessToLocationResponse(*, organization_identities: collections.abc.Iterable[global___OrganizationIdentity] | 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 organization_identities: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationIdentity]
class viam.proto.app.GetRegistryItemRequest(*, item_id: str = ...)

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.

item_id: str
class viam.proto.app.GetRegistryItemResponse(*, item: global___RegistryItem | 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 item: global___RegistryItem
HasField(field_name: Literal['item', b'item']) 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.app.GetRobotAPIKeysRequest(*, robot_id: str = ...)

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.

robot_id: str
class viam.proto.app.GetRobotAPIKeysResponse(*, api_keys: collections.abc.Iterable[global___APIKeyWithAuthorizations] | 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 api_keys: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___APIKeyWithAuthorizations]
class viam.proto.app.GetRobotPartHistoryRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.GetRobotPartHistoryResponse(*, history: collections.abc.Iterable[global___RobotPartHistoryEntry] | 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 history: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RobotPartHistoryEntry]
class viam.proto.app.GetRobotPartLogsRequest(*, id: str = ..., errors_only: bool = ..., filter: str | None = ..., page_token: str | None = ..., levels: collections.abc.Iterable[str] | 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.

id: str
errors_only: bool

Remove this field

Type:

TODO(https

Type:

//viam.atlassian.net/browse/APP-3877)

filter: str
page_token: str
property levels: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

logs of all levels are returned when the levels field is empty

HasField(field_name: Literal['_filter', b'_filter', '_page_token', b'_page_token', 'filter', b'filter', 'page_token', b'page_token']) 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.

WhichOneof(oneof_group: Literal['_filter', b'_filter']) Literal['filter'] | None
WhichOneof(oneof_group: Literal['_page_token', b'_page_token']) Literal['page_token'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.GetRobotPartLogsResponse(*, logs: collections.abc.Iterable[viam.gen.common.v1.common_pb2.LogEntry] | None = ..., next_page_token: str = ...)

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.

next_page_token: str
property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]
class viam.proto.app.GetRobotPartRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.GetRobotPartResponse(*, part: global___RobotPart | None = ..., config_json: str = ...)

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.

config_json: str
property part: global___RobotPart
HasField(field_name: Literal['part', b'part']) 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.app.GetRobotPartsRequest(*, robot_id: str = ...)

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.

robot_id: str
class viam.proto.app.GetRobotPartsResponse(*, parts: collections.abc.Iterable[global___RobotPart] | 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 parts: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RobotPart]
class viam.proto.app.GetRobotRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.GetRobotResponse(*, robot: global___Robot | 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 robot: global___Robot
HasField(field_name: Literal['robot', b'robot']) 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.app.GetRoverRentalRobotsRequest(*, org_id: str = ...)

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.

org_id: str
class viam.proto.app.GetRoverRentalRobotsResponse(*, robots: collections.abc.Iterable[global___RoverRentalRobot] | 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 robots: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RoverRentalRobot]
class viam.proto.app.GetUserIDByEmailRequest(*, email: str = ...)

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.

email: str
class viam.proto.app.GetUserIDByEmailResponse(*, user_id: str = ...)

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.

user_id: str
class viam.proto.app.ListAuthorizationsRequest(*, organization_id: str = ..., resource_ids: collections.abc.Iterable[str] | 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.

organization_id: str
property resource_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

optional filter

class viam.proto.app.ListAuthorizationsResponse(*, authorizations: collections.abc.Iterable[global___Authorization] | 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 authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
class viam.proto.app.ListFragmentsRequest(*, organization_id: str = ..., show_public: bool = ..., fragment_visibility: collections.abc.Iterable[global___FragmentVisibility] | 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.

organization_id: str
show_public: bool
property fragment_visibility: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___FragmentVisibility]
class viam.proto.app.ListFragmentsResponse(*, fragments: collections.abc.Iterable[global___Fragment] | 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 fragments: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Fragment]
class viam.proto.app.ListKeysRequest(*, org_id: str = ...)

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.

org_id: str
class viam.proto.app.ListKeysResponse(*, api_keys: collections.abc.Iterable[global___APIKeyWithAuthorizations] | 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 api_keys: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___APIKeyWithAuthorizations]
class viam.proto.app.ListLocationsRequest(*, organization_id: str = ...)

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.

organization_id: str

Organization ID under which to list all locations.

class viam.proto.app.ListLocationsResponse(*, locations: collections.abc.Iterable[global___Location] | 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 locations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Location]
class viam.proto.app.ListMachineFragmentsRequest(*, machine_id: str = ..., additional_fragment_ids: collections.abc.Iterable[str] | 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.

machine_id: str

the machine_id used to filter fragments defined in a machine’s parts. Also returns any fragments nested within the fragments defined in parts.

property additional_fragment_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

additional fragment_ids to append to the response. useful when needing to view fragments that will be provisionally added to the machine alongside existing fragments.

class viam.proto.app.ListMachineFragmentsResponse(*, fragments: collections.abc.Iterable[global___Fragment] | 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 fragments: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Fragment]
class viam.proto.app.ListModulesRequest(*, organization_id: str | 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.

organization_id: str

The id of the organization to return private modules for.

HasField(field_name: Literal['_organization_id', b'_organization_id', 'organization_id', b'organization_id']) 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.

WhichOneof(oneof_group: Literal['_organization_id', b'_organization_id']) Literal['organization_id'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.ListModulesResponse(*, modules: collections.abc.Iterable[global___Module] | 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 modules: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Module]

A listed of modules. When authenticated, this API will return modules that are private for this org. Public modules are always returned.

class viam.proto.app.ListOrganizationMembersRequest(*, organization_id: str = ...)

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.

organization_id: str
class viam.proto.app.ListOrganizationMembersResponse(*, organization_id: str = ..., members: collections.abc.Iterable[global___OrganizationMember] | None = ..., invites: collections.abc.Iterable[global___OrganizationInvite] | 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.

organization_id: str
property members: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationMember]
property invites: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationInvite]
class viam.proto.app.ListOrganizationsByUserRequest(*, user_id: str = ...)

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.

user_id: str
class viam.proto.app.ListOrganizationsByUserResponse(*, orgs: collections.abc.Iterable[global___OrgDetails] | 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 orgs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrgDetails]
class viam.proto.app.ListOrganizationsRequest

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.

class viam.proto.app.ListOrganizationsResponse(*, organizations: collections.abc.Iterable[global___Organization] | 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 organizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Organization]
class viam.proto.app.ListRegistryItemsRequest(*, organization_id: str | None = ..., types: collections.abc.Iterable[viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType] | None = ..., visibilities: collections.abc.Iterable[global___Visibility] | None = ..., platforms: collections.abc.Iterable[str] | None = ..., statuses: collections.abc.Iterable[global___RegistryItemStatus] | None = ..., search_term: str | None = ..., page_token: str | None = ..., public_namespaces: collections.abc.Iterable[str] | 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.

organization_id: str

The id of the organization to return registry items for.

search_term: str
page_token: str
property types: google.protobuf.internal.containers.RepeatedScalarFieldContainer[viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType]
property visibilities: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___Visibility]
property platforms: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property statuses: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___RegistryItemStatus]
property public_namespaces: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

One or more public namespaces to return results for.

HasField(field_name: Literal['_organization_id', b'_organization_id', '_page_token', b'_page_token', '_search_term', b'_search_term', 'organization_id', b'organization_id', 'page_token', b'page_token', 'search_term', b'search_term']) 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.

WhichOneof(oneof_group: Literal['_organization_id', b'_organization_id']) Literal['organization_id'] | None
WhichOneof(oneof_group: Literal['_page_token', b'_page_token']) Literal['page_token'] | None
WhichOneof(oneof_group: Literal['_search_term', b'_search_term']) Literal['search_term'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.ListRegistryItemsResponse(*, items: collections.abc.Iterable[global___RegistryItem] | 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 items: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RegistryItem]
class viam.proto.app.ListRobotsRequest(*, location_id: str = ...)

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.

location_id: str
class viam.proto.app.ListRobotsResponse(*, robots: collections.abc.Iterable[global___Robot] | 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 robots: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Robot]
class viam.proto.app.Location(*, id: str = ..., name: str = ..., parent_location_id: str = ..., auth: global___LocationAuth | None = ..., organizations: collections.abc.Iterable[global___LocationOrganization] | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., robot_count: int = ..., config: global___StorageConfig | 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.

id: str

Location ID.

name: str

Location name.

parent_location_id: str

Location ID of the parent location.

robot_count: int
property auth: global___LocationAuth

Location authentication secrets.

property organizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___LocationOrganization]

Organizations that the location is shared with.

property created_on: google.protobuf.timestamp_pb2.Timestamp

Location creation timestamp.

property config: global___StorageConfig

Config for how data in this location is stored.

HasField(field_name: Literal['auth', b'auth', 'config', b'config', 'created_on', b'created_on']) 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.app.LocationAuth(*, secret: str = ..., location_id: str = ..., secrets: collections.abc.Iterable[global___SharedSecret] | 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.

secret: str

use secrets field.

Type:

Deprecated

location_id: str

Location ID containing this LocationAuth.

property secrets: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SharedSecret]

List of secrets used to authenticate to the Location.

class viam.proto.app.LocationAuthRequest(*, location_id: str = ...)

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.

location_id: str
class viam.proto.app.LocationAuthResponse(*, auth: global___LocationAuth | 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 auth: global___LocationAuth
HasField(field_name: Literal['auth', b'auth']) 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.app.LocationOrganization(*, organization_id: str = ..., primary: 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.

organization_id: str

Organization ID the location is shared with.

primary: bool

Whether the organization is the primary owner or not.

class viam.proto.app.MarkPartAsMainRequest(*, part_id: str = ...)

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.

part_id: str
class viam.proto.app.MarkPartAsMainResponse

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.

class viam.proto.app.MarkPartForRestartRequest(*, part_id: str = ...)

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.

part_id: str
class viam.proto.app.MarkPartForRestartResponse

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.

class viam.proto.app.MLModelMetadata(*, versions: collections.abc.Iterable[str] | None = ..., model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType = ...)

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.

model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType
model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType
property versions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

A list of package versions for a ML model

class viam.proto.app.MLTrainingMetadata(*, versions: collections.abc.Iterable[global___MLTrainingVersion] | None = ..., model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType = ..., draft: 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.

model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType
model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType
draft: bool
property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MLTrainingVersion]

A list of package versions for ML training source distribution

class viam.proto.app.MLTrainingVersion(*, version: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | 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.

version: str
property created_on: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['created_on', b'created_on']) 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.app.Model(*, api: str = ..., model: str = ...)

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.

api: str

The colon-delimited-triplet of the api implemented by the model

model: str

The colon-delimited-triplet of the model

class viam.proto.app.Module(*, module_id: str = ..., name: str = ..., visibility: global___Visibility = ..., versions: collections.abc.Iterable[global___VersionHistory] | None = ..., url: str = ..., description: str = ..., models: collections.abc.Iterable[global___Model] | None = ..., total_robot_usage: int = ..., total_organization_usage: int = ..., organization_id: str = ..., entrypoint: str = ..., public_namespace: str = ...)

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.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:

The id of the module (formatted as prefix

name: str

The name of the module

visibility: global___Visibility

The visibility of the module

url: str

The url to reference for documentation, code, etc.

description: str

A short description of the module that explains its purpose

total_robot_usage: int

The total number of robots using this module

total_organization_usage: int

The total number of organizations using this module

organization_id: str

The id of the organization that owns the module

entrypoint: str

The executable to run to start the module program

public_namespace: str

The public namespace of the organization that owns the module This is empty if no public namespace is set

property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___VersionHistory]

The versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]

A list of models that are available in the module

class viam.proto.app.ModuleFileInfo(*, module_id: str = ..., version: str = ..., platform: str = ...)

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.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:

The id of the module (formatted as prefix

version: str

The semver string that represents the new major/minor/patch version of the module

platform: str

The platform that the file is built to run on

class viam.proto.app.ModuleMetadata(*, models: collections.abc.Iterable[global___Model] | None = ..., versions: collections.abc.Iterable[global___ModuleVersion] | None = ..., entrypoint: str = ...)

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.

entrypoint: str

The executable to run to start the module program

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]

A list of models that are available in the module

property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ModuleVersion]

A list of versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version

class viam.proto.app.ModuleVersion(*, version: str = ..., files: collections.abc.Iterable[global___Uploads] | None = ..., models: collections.abc.Iterable[global___Model] | None = ..., entrypoint: str = ...)

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.

version: str

The semver string that represents the major/minor/patch version of the module

entrypoint: str

The entrypoint for this version of the module

property files: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Uploads]

The uploads that are available for this module version

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]

The models that this verion of the module provides

class viam.proto.app.NewRobotPartRequest(*, robot_id: str = ..., part_name: str = ...)

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.

robot_id: str
part_name: str
class viam.proto.app.NewRobotPartResponse(*, part_id: str = ...)

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.

part_id: str
class viam.proto.app.NewRobotRequest(*, name: str = ..., location: str = ...)

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
location: str
class viam.proto.app.NewRobotResponse(*, id: str = ...)

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.

id: str
class viam.proto.app.Organization(*, id: str = ..., name: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., public_namespace: str = ..., default_region: str = ..., cid: str | 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.

id: str
name: str
public_namespace: str
default_region: str

GCS region of the organization. Locations created under this org will have their GCS region set to this by default and packages associated with this org will be stored in this region.

cid: str
property created_on: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['_cid', b'_cid', 'cid', b'cid', 'created_on', b'created_on']) 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.

WhichOneof(oneof_group: Literal['_cid', b'_cid']) Literal['cid'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.OrganizationIdentity(*, id: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Location

Used for rendering an organization’s information on the frontend (limited to id, name, or both).

id: str

Organization ID.

name: str

Organization name.

class viam.proto.app.OrganizationInvite(*, organization_id: str = ..., email: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., authorizations: collections.abc.Iterable[global___Authorization] | 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.

organization_id: str
email: str
property created_on: google.protobuf.timestamp_pb2.Timestamp
property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
HasField(field_name: Literal['created_on', b'created_on']) 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.app.OrganizationMember(*, user_id: str = ..., emails: collections.abc.Iterable[str] | None = ..., date_added: google.protobuf.timestamp_pb2.Timestamp | None = ..., last_login: google.protobuf.timestamp_pb2.Timestamp | 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.

user_id: str
property emails: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
property date_added: google.protobuf.timestamp_pb2.Timestamp
property last_login: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['_last_login', b'_last_login', 'date_added', b'date_added', 'last_login', b'last_login']) 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.

WhichOneof(oneof_group: Literal['_last_login', b'_last_login']) Literal['last_login'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.OrgDetails(*, org_id: str = ..., org_name: str = ...)

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.

org_id: str
org_name: str
class viam.proto.app.RegistryItem(*, item_id: str = ..., organization_id: str = ..., public_namespace: str = ..., name: str = ..., type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType = ..., visibility: global___Visibility = ..., url: str = ..., description: str = ..., total_robot_usage: int = ..., total_external_robot_usage: int = ..., total_organization_usage: int = ..., total_external_organization_usage: int = ..., module_metadata: global___ModuleMetadata | None = ..., ml_model_metadata: global___MLModelMetadata | None = ..., ml_training_metadata: global___MLTrainingMetadata | None = ..., created_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | 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.

item_id: str

The id of the item, containing either: namespace:item_name when a namespace exists on the org. org_id:item_name when a namespace does not exist.

organization_id: str

The id of the organization that owns the item

public_namespace: str

The public namespace of the organization that owns the module This is empty if no public namespace is set

name: str

The name of the registry item

type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType

The type of the item in the registry

visibility: global___Visibility

The visibility of the registry item

url: str

The url to reference for documentation, code, etc.

description: str

A short description of the item that explains its purpose

total_robot_usage: int

The total number of robots using this item

total_external_robot_usage: int

The total number of robots using this item outside of the owning org

total_organization_usage: int

The total number of organizations using this item

total_external_organization_usage: int

The total number of organizations using this item outside of the owning org

property module_metadata: global___ModuleMetadata
property ml_model_metadata: global___MLModelMetadata
property ml_training_metadata: global___MLTrainingMetadata
property created_at: google.protobuf.timestamp_pb2.Timestamp

When the item was created

property updated_at: google.protobuf.timestamp_pb2.Timestamp

When the item was last updated, either through an update or upload.

HasField(field_name: Literal['created_at', b'created_at', 'metadata', b'metadata', 'ml_model_metadata', b'ml_model_metadata', 'ml_training_metadata', b'ml_training_metadata', 'module_metadata', b'module_metadata', 'updated_at', b'updated_at']) 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.

WhichOneof(oneof_group: Literal['metadata', b'metadata']) Literal['module_metadata', 'ml_model_metadata', 'ml_training_metadata'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.RegistryItemStatus

Bases: _RegistryItemStatus

class viam.proto.app.RemoveRoleRequest(*, authorization: global___Authorization | 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 authorization: global___Authorization
HasField(field_name: Literal['authorization', b'authorization']) 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.app.RemoveRoleResponse

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.

class viam.proto.app.RenameKeyRequest(*, id: str = ..., name: str = ...)

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.

id: str
name: str
class viam.proto.app.RenameKeyResponse(*, id: str = ..., name: str = ...)

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.

id: str
name: str
class viam.proto.app.ResendOrganizationInviteRequest(*, organization_id: str = ..., email: str = ...)

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.

organization_id: str
email: str
class viam.proto.app.ResendOrganizationInviteResponse(*, invite: global___OrganizationInvite | 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 invite: global___OrganizationInvite
HasField(field_name: Literal['invite', b'invite']) 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.app.Robot(*, id: str = ..., name: str = ..., location: str = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | 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.

id: str
name: str
location: str
property last_access: google.protobuf.timestamp_pb2.Timestamp
property created_on: google.protobuf.timestamp_pb2.Timestamp
HasField(field_name: Literal['created_on', b'created_on', 'last_access', b'last_access']) 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.app.RobotPart(*, id: str = ..., name: str = ..., dns_name: str = ..., secret: str = ..., robot: str = ..., location_id: str = ..., robot_config: google.protobuf.struct_pb2.Struct | None = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., user_supplied_info: google.protobuf.struct_pb2.Struct | None = ..., main_part: bool = ..., fqdn: str = ..., local_fqdn: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., secrets: collections.abc.Iterable[global___SharedSecret] | 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.

id: str
name: str
dns_name: str

dns_name part name used for fqdn and local fqdn. Anytime the Name is updated this should be sanitized and updated as well.

secret: str
robot: str
location_id: str

Store the location_id to allow for unique indexes across parts and locations. This filed MUST be updated each time the robots location changes.

main_part: bool
fqdn: str
local_fqdn: str
property robot_config: google.protobuf.struct_pb2.Struct
property last_access: google.protobuf.timestamp_pb2.Timestamp
property user_supplied_info: google.protobuf.struct_pb2.Struct
property created_on: google.protobuf.timestamp_pb2.Timestamp
property secrets: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SharedSecret]

List of secrets allowed for authentication.

HasField(field_name: Literal['created_on', b'created_on', 'last_access', b'last_access', 'robot_config', b'robot_config', 'user_supplied_info', b'user_supplied_info']) 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.app.RobotPartHistoryEntry(*, part: str = ..., robot: str = ..., when: google.protobuf.timestamp_pb2.Timestamp | None = ..., old: global___RobotPart | None = ..., edited_by: global___AuthenticatorInfo | 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.

part: str
robot: str
property when: google.protobuf.timestamp_pb2.Timestamp
property old: global___RobotPart
property edited_by: global___AuthenticatorInfo
HasField(field_name: Literal['edited_by', b'edited_by', 'old', b'old', 'when', b'when']) 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.app.RotateKeyRequest(*, id: str = ...)

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.

id: str
class viam.proto.app.RotateKeyResponse(*, id: str = ..., key: str = ...)

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.

id: str
key: str