viam.proto.app

@generated by Viam. Do not edit manually!

Submodules

• viam.proto.app.agent
• viam.proto.app.billing
• viam.proto.app.cloudslam
• viam.proto.app.data
• viam.proto.app.datapipelines
• viam.proto.app.dataset
• viam.proto.app.datasync
• viam.proto.app.end_user
• viam.proto.app.mlinference
• viam.proto.app.mltraining
• viam.proto.app.packages
• viam.proto.app.robot

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
PKCE
AdditionalFragment	Abstract base class for protocol messages.
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.
App	Abstract base class for protocol messages.
AppCustomizations	Abstract base class for protocol messages.
AppType
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.
BillingAddress	Third Party Org Services
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.
ClientAuthentication
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.
CreateOAuthAppRequest	Abstract base class for protocol messages.
CreateOAuthAppResponse	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.
DeleteFragmentTagRequest	Abstract base class for protocol messages.
DeleteFragmentTagResponse	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.
DeleteOAuthAppRequest	Abstract base class for protocol messages.
DeleteOAuthAppResponse	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.
DisableAuthServiceRequest	Abstract base class for protocol messages.
DisableAuthServiceResponse	Abstract base class for protocol messages.
DisableBillingServiceRequest	Abstract base class for protocol messages.
DisableBillingServiceResponse	Abstract base class for protocol messages.
EnableAuthServiceRequest	Abstract base class for protocol messages.
EnableAuthServiceResponse	Abstract base class for protocol messages.
EnableBillingServiceRequest	Abstract base class for protocol messages.
EnableBillingServiceResponse	Abstract base class for protocol messages.
EnabledGrant
Fragment	Abstract base class for protocol messages.
FragmentError	Abstract base class for protocol messages.
FragmentErrorType
FragmentHistoryEntry	Abstract base class for protocol messages.
FragmentImport	Abstract base class for protocol messages.
FragmentImportList	Abstract base class for protocol messages.
FragmentRevision	Abstract base class for protocol messages.
FragmentSummary	Abstract base class for protocol messages.
FragmentTag	Abstract base class for protocol messages.
FragmentUsage	Cached fragment usage statistics
FragmentVisibility
GetAppBrandingRequest	Branding and customization for app machine picker
GetAppBrandingResponse	Abstract base class for protocol messages.
GetAppContentRequest	Abstract base class for protocol messages.
GetAppContentResponse	Abstract base class for protocol messages.
GetBillingServiceConfigRequest	Abstract base class for protocol messages.
GetBillingServiceConfigResponse	Abstract base class for protocol messages.
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.
GetFragmentUsageRequest	Abstract base class for protocol messages.
GetFragmentUsageResponse	Abstract base class for protocol messages.
GetLocationMetadataRequest	Abstract base class for protocol messages.
GetLocationMetadataResponse	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.
GetOrganizationMetadataRequest	Abstract base class for protocol messages.
GetOrganizationMetadataResponse	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.
GetRobotMetadataRequest	Abstract base class for protocol messages.
GetRobotMetadataResponse	Abstract base class for protocol messages.
GetRobotPartByNameAndLocationRequest	Abstract base class for protocol messages.
GetRobotPartByNameAndLocationResponse	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.
GetRobotPartMetadataRequest	Abstract base class for protocol messages.
GetRobotPartMetadataResponse	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.
ListMachineSummariesRequest	Abstract base class for protocol messages.
ListMachineSummariesResponse	Abstract base class for protocol messages.
ListModulesRequest	Abstract base class for protocol messages.
ListModulesResponse	Abstract base class for protocol messages.
ListNestedFragmentsRequest	Abstract base class for protocol messages.
ListNestedFragmentsResponse	Abstract base class for protocol messages.
ListOAuthAppsRequest	Abstract base class for protocol messages.
ListOAuthAppsResponse	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.
ListRobotsForLocationsRequest	Abstract base class for protocol messages.
ListRobotsForLocationsResponse	Abstract base class for protocol messages.
ListRobotsForOrgRequest	Abstract base class for protocol messages.
ListRobotsForOrgResponse	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.
LocationSummary	Abstract base class for protocol messages.
MachinePickerCustomizations	Abstract base class for protocol messages.
MachineSummary	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.
MLModelVersion	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.
ModuleLanguage
ModuleMetadata	Abstract base class for protocol messages.
ModuleSourceType
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.
OAuthConfig	Abstract base class for protocol messages.
OnlineState
Organization	Abstract base class for protocol messages.
OrganizationGetLogoRequest	Abstract base class for protocol messages.
OrganizationGetLogoResponse	Abstract base class for protocol messages.
OrganizationGetSupportEmailRequest	Abstract base class for protocol messages.
OrganizationGetSupportEmailResponse	Abstract base class for protocol messages.
OrganizationIdentity	Location
OrganizationInvite	Abstract base class for protocol messages.
OrganizationMember	Abstract base class for protocol messages.
OrganizationSetLogoRequest	Abstract base class for protocol messages.
OrganizationSetLogoResponse	Abstract base class for protocol messages.
OrganizationSetSupportEmailRequest	Abstract base class for protocol messages.
OrganizationSetSupportEmailResponse	Abstract base class for protocol messages.
OrgDetails	Abstract base class for protocol messages.
PartSummary	Abstract base class for protocol messages.
ReadOAuthAppRequest	Abstract base class for protocol messages.
ReadOAuthAppResponse	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.
RenameRegistryItemRequest	Abstract base class for protocol messages.
RenameRegistryItemResponse	Abstract base class for protocol messages.
ResendOrganizationInviteRequest	Abstract base class for protocol messages.
ResendOrganizationInviteResponse	Abstract base class for protocol messages.
ResolvedFragment	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.
SearchOrganizationsRequest	Abstract base class for protocol messages.
SearchOrganizationsResponse	Abstract base class for protocol messages.
SetFragmentTagRequest	Abstract base class for protocol messages.
SetFragmentTagResponse	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.
TextOverrides	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.
UpdateBillingServiceRequest	Abstract base class for protocol messages.
UpdateBillingServiceResponse	Abstract base class for protocol messages.
UpdateFragmentRequest	Abstract base class for protocol messages.
UpdateFragmentResponse	Abstract base class for protocol messages.
UpdateLocationMetadataRequest	Abstract base class for protocol messages.
UpdateLocationMetadataResponse	Abstract base class for protocol messages.
UpdateLocationRequest	Abstract base class for protocol messages.
UpdateLocationResponse	Abstract base class for protocol messages.
UpdateMLModelMetadata	Abstract base class for protocol messages.
UpdateMLTrainingMetadata	Abstract base class for protocol messages.
UpdateModuleMetadata	Abstract base class for protocol messages.
UpdateModuleRequest	Abstract base class for protocol messages.
UpdateModuleResponse	Abstract base class for protocol messages.
UpdateOAuthAppRequest	Abstract base class for protocol messages.
UpdateOAuthAppResponse	Abstract base class for protocol messages.
UpdateOrganizationInviteAuthorizationsRequest	Abstract base class for protocol messages.
UpdateOrganizationInviteAuthorizationsResponse	Abstract base class for protocol messages.
UpdateOrganizationMetadataRequest	Abstract base class for protocol messages.
UpdateOrganizationMetadataResponse	Abstract base class for protocol messages.
UpdateOrganizationNamespaceRequest	Abstract base class for protocol messages.
UpdateOrganizationNamespaceResponse	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.
UpdateRobotMetadataRequest	Abstract base class for protocol messages.
UpdateRobotMetadataResponse	Abstract base class for protocol messages.
UpdateRobotPartMetadataRequest	Abstract base class for protocol messages.
UpdateRobotPartMetadataResponse	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.
URLValidation
VersionHistory	Abstract base class for protocol messages.
ViamAgentVersion	Abstract base class for protocol messages.
ViamServerVersion	Abstract base class for protocol messages.
Visibility

Package Contents

class viam.proto.app.AppServiceBase

Bases: abc.ABC

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

abstractmethod GetUserIDByEmail(stream: grpclib.server.Stream[app.v1.app_pb2.GetUserIDByEmailRequest, app.v1.app_pb2.GetUserIDByEmailResponse]) → None

Async:

abstractmethod CreateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationRequest, app.v1.app_pb2.CreateOrganizationResponse]) → None

Async:

abstractmethod ListOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsRequest, app.v1.app_pb2.ListOrganizationsResponse]) → None

Async:

abstractmethod GetOrganizationsWithAccessToLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationsWithAccessToLocationRequest, app.v1.app_pb2.GetOrganizationsWithAccessToLocationResponse]) → None

Async:

abstractmethod ListOrganizationsByUser(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsByUserRequest, app.v1.app_pb2.ListOrganizationsByUserResponse]) → None

Async:

abstractmethod SearchOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.SearchOrganizationsRequest, app.v1.app_pb2.SearchOrganizationsResponse]) → None

Async:

abstractmethod GetOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationRequest, app.v1.app_pb2.GetOrganizationResponse]) → None

Async:

abstractmethod GetOrganizationNamespaceAvailability(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationNamespaceAvailabilityRequest, app.v1.app_pb2.GetOrganizationNamespaceAvailabilityResponse]) → None

Async:

abstractmethod UpdateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationRequest, app.v1.app_pb2.UpdateOrganizationResponse]) → None

Async:

abstractmethod UpdateOrganizationNamespace(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationNamespaceRequest, app.v1.app_pb2.UpdateOrganizationNamespaceResponse]) → None

Async:

abstractmethod DeleteOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationRequest, app.v1.app_pb2.DeleteOrganizationResponse]) → None

Async:

abstractmethod GetOrganizationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationMetadataRequest, app.v1.app_pb2.GetOrganizationMetadataResponse]) → None

Async:

abstractmethod UpdateOrganizationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationMetadataRequest, app.v1.app_pb2.UpdateOrganizationMetadataResponse]) → None

Async:

abstractmethod ListOrganizationMembers(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationMembersRequest, app.v1.app_pb2.ListOrganizationMembersResponse]) → None

Async:

abstractmethod CreateOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationInviteRequest, app.v1.app_pb2.CreateOrganizationInviteResponse]) → None

Async:

abstractmethod UpdateOrganizationInviteAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsRequest, app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsResponse]) → None

Async:

abstractmethod DeleteOrganizationMember(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationMemberRequest, app.v1.app_pb2.DeleteOrganizationMemberResponse]) → None

Async:

abstractmethod DeleteOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationInviteRequest, app.v1.app_pb2.DeleteOrganizationInviteResponse]) → None

Async:

abstractmethod ResendOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.ResendOrganizationInviteRequest, app.v1.app_pb2.ResendOrganizationInviteResponse]) → None

Async:

abstractmethod EnableBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.EnableBillingServiceRequest, app.v1.app_pb2.EnableBillingServiceResponse]) → None

Async:

abstractmethod DisableBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.DisableBillingServiceRequest, app.v1.app_pb2.DisableBillingServiceResponse]) → None

Async:

abstractmethod UpdateBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateBillingServiceRequest, app.v1.app_pb2.UpdateBillingServiceResponse]) → None

Async:

abstractmethod GetBillingServiceConfig(stream: grpclib.server.Stream[app.v1.app_pb2.GetBillingServiceConfigRequest, app.v1.app_pb2.GetBillingServiceConfigResponse]) → None

Async:

abstractmethod OrganizationSetSupportEmail(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationSetSupportEmailRequest, app.v1.app_pb2.OrganizationSetSupportEmailResponse]) → None

Async:

abstractmethod OrganizationGetSupportEmail(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationGetSupportEmailRequest, app.v1.app_pb2.OrganizationGetSupportEmailResponse]) → None

Async:

abstractmethod OrganizationSetLogo(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationSetLogoRequest, app.v1.app_pb2.OrganizationSetLogoResponse]) → None

Async:

abstractmethod OrganizationGetLogo(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationGetLogoRequest, app.v1.app_pb2.OrganizationGetLogoResponse]) → None

Async:

abstractmethod EnableAuthService(stream: grpclib.server.Stream[app.v1.app_pb2.EnableAuthServiceRequest, app.v1.app_pb2.EnableAuthServiceResponse]) → None

Async:

abstractmethod DisableAuthService(stream: grpclib.server.Stream[app.v1.app_pb2.DisableAuthServiceRequest, app.v1.app_pb2.DisableAuthServiceResponse]) → None

Async:

abstractmethod CreateOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOAuthAppRequest, app.v1.app_pb2.CreateOAuthAppResponse]) → None

Async:

abstractmethod ReadOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.ReadOAuthAppRequest, app.v1.app_pb2.ReadOAuthAppResponse]) → None

Async:

abstractmethod UpdateOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOAuthAppRequest, app.v1.app_pb2.UpdateOAuthAppResponse]) → None

Async:

abstractmethod DeleteOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOAuthAppRequest, app.v1.app_pb2.DeleteOAuthAppResponse]) → None

Async:

abstractmethod ListOAuthApps(stream: grpclib.server.Stream[app.v1.app_pb2.ListOAuthAppsRequest, app.v1.app_pb2.ListOAuthAppsResponse]) → None

Async:

abstractmethod CreateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationRequest, app.v1.app_pb2.CreateLocationResponse]) → None

Async:

abstractmethod GetLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationRequest, app.v1.app_pb2.GetLocationResponse]) → None

Async:

abstractmethod UpdateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationRequest, app.v1.app_pb2.UpdateLocationResponse]) → None

Async:

abstractmethod DeleteLocation(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationRequest, app.v1.app_pb2.DeleteLocationResponse]) → None

Async:

abstractmethod GetLocationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationMetadataRequest, app.v1.app_pb2.GetLocationMetadataResponse]) → None

Async:

abstractmethod UpdateLocationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationMetadataRequest, app.v1.app_pb2.UpdateLocationMetadataResponse]) → None

Async:

abstractmethod ListLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListLocationsRequest, app.v1.app_pb2.ListLocationsResponse]) → None

Async:

abstractmethod ShareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.ShareLocationRequest, app.v1.app_pb2.ShareLocationResponse]) → None

Async:

abstractmethod UnshareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UnshareLocationRequest, app.v1.app_pb2.UnshareLocationResponse]) → None

Async:

abstractmethod LocationAuth(stream: grpclib.server.Stream[app.v1.app_pb2.LocationAuthRequest, app.v1.app_pb2.LocationAuthResponse]) → None

Async:

abstractmethod CreateLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationSecretRequest, app.v1.app_pb2.CreateLocationSecretResponse]) → None

Async:

abstractmethod DeleteLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationSecretRequest, app.v1.app_pb2.DeleteLocationSecretResponse]) → None

Async:

abstractmethod GetRobot(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotRequest, app.v1.app_pb2.GetRobotResponse]) → None

Async:

abstractmethod GetRobotMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotMetadataRequest, app.v1.app_pb2.GetRobotMetadataResponse]) → None

Async:

abstractmethod UpdateRobotMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotMetadataRequest, app.v1.app_pb2.UpdateRobotMetadataResponse]) → None

Async:

abstractmethod GetRoverRentalRobots(stream: grpclib.server.Stream[app.v1.app_pb2.GetRoverRentalRobotsRequest, app.v1.app_pb2.GetRoverRentalRobotsResponse]) → None

Async:

abstractmethod GetRobotParts(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartsRequest, app.v1.app_pb2.GetRobotPartsResponse]) → None

Async:

abstractmethod GetRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartRequest, app.v1.app_pb2.GetRobotPartResponse]) → None

Async:

abstractmethod GetRobotPartByNameAndLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartByNameAndLocationRequest, app.v1.app_pb2.GetRobotPartByNameAndLocationResponse]) → None

Async:

abstractmethod GetRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartLogsRequest, app.v1.app_pb2.GetRobotPartLogsResponse]) → None

Async:

abstractmethod TailRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.TailRobotPartLogsRequest, app.v1.app_pb2.TailRobotPartLogsResponse]) → None

Async:

abstractmethod GetRobotPartHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartHistoryRequest, app.v1.app_pb2.GetRobotPartHistoryResponse]) → None

Async:

abstractmethod UpdateRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartRequest, app.v1.app_pb2.UpdateRobotPartResponse]) → None

Async:

abstractmethod NewRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotPartRequest, app.v1.app_pb2.NewRobotPartResponse]) → None

Async:

abstractmethod DeleteRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartRequest, app.v1.app_pb2.DeleteRobotPartResponse]) → None

Async:

abstractmethod GetRobotPartMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartMetadataRequest, app.v1.app_pb2.GetRobotPartMetadataResponse]) → None

Async:

abstractmethod UpdateRobotPartMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartMetadataRequest, app.v1.app_pb2.UpdateRobotPartMetadataResponse]) → None

Async:

abstractmethod GetRobotAPIKeys(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotAPIKeysRequest, app.v1.app_pb2.GetRobotAPIKeysResponse]) → None

Async:

abstractmethod MarkPartAsMain(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartAsMainRequest, app.v1.app_pb2.MarkPartAsMainResponse]) → None

Async:

abstractmethod MarkPartForRestart(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartForRestartRequest, app.v1.app_pb2.MarkPartForRestartResponse]) → None

Async:

abstractmethod CreateRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRobotPartSecretRequest, app.v1.app_pb2.CreateRobotPartSecretResponse]) → None

Async:

abstractmethod DeleteRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartSecretRequest, app.v1.app_pb2.DeleteRobotPartSecretResponse]) → None

Async:

abstractmethod ListRobots(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsRequest, app.v1.app_pb2.ListRobotsResponse]) → None

Async:

abstractmethod ListRobotsForLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsForLocationsRequest, app.v1.app_pb2.ListRobotsForLocationsResponse]) → None

Async:

abstractmethod ListRobotsForOrg(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsForOrgRequest, app.v1.app_pb2.ListRobotsForOrgResponse]) → None

Async:

abstractmethod NewRobot(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotRequest, app.v1.app_pb2.NewRobotResponse]) → None

Async:

abstractmethod UpdateRobot(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotRequest, app.v1.app_pb2.UpdateRobotResponse]) → None

Async:

abstractmethod DeleteRobot(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotRequest, app.v1.app_pb2.DeleteRobotResponse]) → None

Async:

abstractmethod ListFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListFragmentsRequest, app.v1.app_pb2.ListFragmentsResponse]) → None

Async:

abstractmethod GetFragment(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentRequest, app.v1.app_pb2.GetFragmentResponse]) → None

Async:

abstractmethod CreateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.CreateFragmentRequest, app.v1.app_pb2.CreateFragmentResponse]) → None

Async:

abstractmethod UpdateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateFragmentRequest, app.v1.app_pb2.UpdateFragmentResponse]) → None

Async:

abstractmethod DeleteFragment(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentRequest, app.v1.app_pb2.DeleteFragmentResponse]) → None

Async:

abstractmethod ListNestedFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListNestedFragmentsRequest, app.v1.app_pb2.ListNestedFragmentsResponse]) → None

Async:

abstractmethod ListMachineFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineFragmentsRequest, app.v1.app_pb2.ListMachineFragmentsResponse]) → None

Async:

abstractmethod ListMachineSummaries(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineSummariesRequest, app.v1.app_pb2.ListMachineSummariesResponse]) → None

Async:

abstractmethod GetFragmentHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentHistoryRequest, app.v1.app_pb2.GetFragmentHistoryResponse]) → None

Async:

abstractmethod GetFragmentUsage(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentUsageRequest, app.v1.app_pb2.GetFragmentUsageResponse]) → None

Async:

abstractmethod SetFragmentTag(stream: grpclib.server.Stream[app.v1.app_pb2.SetFragmentTagRequest, app.v1.app_pb2.SetFragmentTagResponse]) → None

Async:

abstractmethod DeleteFragmentTag(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentTagRequest, app.v1.app_pb2.DeleteFragmentTagResponse]) → None

Async:

abstractmethod AddRole(stream: grpclib.server.Stream[app.v1.app_pb2.AddRoleRequest, app.v1.app_pb2.AddRoleResponse]) → None

Async:

abstractmethod RemoveRole(stream: grpclib.server.Stream[app.v1.app_pb2.RemoveRoleRequest, app.v1.app_pb2.RemoveRoleResponse]) → None

Async:

abstractmethod ChangeRole(stream: grpclib.server.Stream[app.v1.app_pb2.ChangeRoleRequest, app.v1.app_pb2.ChangeRoleResponse]) → None

Async:

abstractmethod ListAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListAuthorizationsRequest, app.v1.app_pb2.ListAuthorizationsResponse]) → None

Async:

abstractmethod CheckPermissions(stream: grpclib.server.Stream[app.v1.app_pb2.CheckPermissionsRequest, app.v1.app_pb2.CheckPermissionsResponse]) → None

Async:

abstractmethod GetRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.GetRegistryItemRequest, app.v1.app_pb2.GetRegistryItemResponse]) → None

Async:

abstractmethod CreateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRegistryItemRequest, app.v1.app_pb2.CreateRegistryItemResponse]) → None

Async:

abstractmethod UpdateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRegistryItemRequest, app.v1.app_pb2.UpdateRegistryItemResponse]) → None

Async:

abstractmethod ListRegistryItems(stream: grpclib.server.Stream[app.v1.app_pb2.ListRegistryItemsRequest, app.v1.app_pb2.ListRegistryItemsResponse]) → None

Async:

abstractmethod DeleteRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRegistryItemRequest, app.v1.app_pb2.DeleteRegistryItemResponse]) → None

Async:

abstractmethod RenameRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.RenameRegistryItemRequest, app.v1.app_pb2.RenameRegistryItemResponse]) → None

Async:

abstractmethod TransferRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.TransferRegistryItemRequest, app.v1.app_pb2.TransferRegistryItemResponse]) → None

Async:

abstractmethod CreateModule(stream: grpclib.server.Stream[app.v1.app_pb2.CreateModuleRequest, app.v1.app_pb2.CreateModuleResponse]) → None

Async:

abstractmethod UpdateModule(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateModuleRequest, app.v1.app_pb2.UpdateModuleResponse]) → None

Async:

abstractmethod UploadModuleFile(stream: grpclib.server.Stream[app.v1.app_pb2.UploadModuleFileRequest, app.v1.app_pb2.UploadModuleFileResponse]) → None

Async:

abstractmethod GetModule(stream: grpclib.server.Stream[app.v1.app_pb2.GetModuleRequest, app.v1.app_pb2.GetModuleResponse]) → None

Async:

abstractmethod ListModules(stream: grpclib.server.Stream[app.v1.app_pb2.ListModulesRequest, app.v1.app_pb2.ListModulesResponse]) → None

Async:

abstractmethod CreateKey(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyRequest, app.v1.app_pb2.CreateKeyResponse]) → None

Async:

abstractmethod DeleteKey(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteKeyRequest, app.v1.app_pb2.DeleteKeyResponse]) → None

Async:

abstractmethod ListKeys(stream: grpclib.server.Stream[app.v1.app_pb2.ListKeysRequest, app.v1.app_pb2.ListKeysResponse]) → None

Async:

abstractmethod RenameKey(stream: grpclib.server.Stream[app.v1.app_pb2.RenameKeyRequest, app.v1.app_pb2.RenameKeyResponse]) → None

Async:

abstractmethod RotateKey(stream: grpclib.server.Stream[app.v1.app_pb2.RotateKeyRequest, app.v1.app_pb2.RotateKeyResponse]) → None

Async:

abstractmethod CreateKeyFromExistingKeyAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsRequest, app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsResponse]) → None

Async:

abstractmethod GetAppContent(stream: grpclib.server.Stream[app.v1.app_pb2.GetAppContentRequest, app.v1.app_pb2.GetAppContentResponse]) → None

Async:

abstractmethod GetAppBranding(stream: grpclib.server.Stream[app.v1.app_pb2.GetAppBrandingRequest, app.v1.app_pb2.GetAppBrandingResponse]) → None

Async:

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

class viam.proto.app.AppServiceStub(channel: grpclib.client.Channel)

GetUserIDByEmail

CreateOrganization

ListOrganizations

GetOrganizationsWithAccessToLocation

ListOrganizationsByUser

SearchOrganizations

GetOrganization

GetOrganizationNamespaceAvailability

UpdateOrganization

UpdateOrganizationNamespace

DeleteOrganization

GetOrganizationMetadata

UpdateOrganizationMetadata

ListOrganizationMembers

CreateOrganizationInvite

UpdateOrganizationInviteAuthorizations

DeleteOrganizationMember

DeleteOrganizationInvite

ResendOrganizationInvite

EnableBillingService

DisableBillingService

UpdateBillingService

GetBillingServiceConfig

OrganizationSetSupportEmail

OrganizationGetSupportEmail

OrganizationSetLogo

OrganizationGetLogo

EnableAuthService

DisableAuthService

CreateOAuthApp

ReadOAuthApp

UpdateOAuthApp

DeleteOAuthApp

ListOAuthApps

CreateLocation

GetLocation

UpdateLocation

DeleteLocation

GetLocationMetadata

UpdateLocationMetadata

ListLocations

ShareLocation

UnshareLocation

LocationAuth

CreateLocationSecret

DeleteLocationSecret

GetRobot

GetRobotMetadata

UpdateRobotMetadata

GetRoverRentalRobots

GetRobotParts

GetRobotPart

GetRobotPartByNameAndLocation

GetRobotPartLogs

TailRobotPartLogs

GetRobotPartHistory

UpdateRobotPart

NewRobotPart

DeleteRobotPart

GetRobotPartMetadata

UpdateRobotPartMetadata

GetRobotAPIKeys

MarkPartAsMain

MarkPartForRestart

CreateRobotPartSecret

DeleteRobotPartSecret

ListRobots

ListRobotsForLocations

ListRobotsForOrg

NewRobot

UpdateRobot

DeleteRobot

ListFragments

GetFragment

CreateFragment

UpdateFragment

DeleteFragment

ListNestedFragments

ListMachineFragments

ListMachineSummaries

GetFragmentHistory

GetFragmentUsage

SetFragmentTag

DeleteFragmentTag

AddRole

RemoveRole

ChangeRole

ListAuthorizations

CheckPermissions

GetRegistryItem

CreateRegistryItem

UpdateRegistryItem

ListRegistryItems

DeleteRegistryItem

RenameRegistryItem

TransferRegistryItem

CreateModule

UpdateModule

UploadModuleFile

GetModule

ListModules

CreateKey

DeleteKey

ListKeys

RenameKey

RotateKey

CreateKeyFromExistingKeyAuthorizations

GetAppContent

GetAppBranding

class viam.proto.app.UnimplementedAppServiceBase

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

async CreateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationRequest, app.v1.app_pb2.CreateOrganizationResponse]) → None

async ListOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsRequest, app.v1.app_pb2.ListOrganizationsResponse]) → None

async GetOrganizationsWithAccessToLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationsWithAccessToLocationRequest, app.v1.app_pb2.GetOrganizationsWithAccessToLocationResponse]) → None

async ListOrganizationsByUser(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationsByUserRequest, app.v1.app_pb2.ListOrganizationsByUserResponse]) → None

async SearchOrganizations(stream: grpclib.server.Stream[app.v1.app_pb2.SearchOrganizationsRequest, app.v1.app_pb2.SearchOrganizationsResponse]) → None

async GetOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationRequest, app.v1.app_pb2.GetOrganizationResponse]) → None

async GetOrganizationNamespaceAvailability(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationNamespaceAvailabilityRequest, app.v1.app_pb2.GetOrganizationNamespaceAvailabilityResponse]) → None

async UpdateOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationRequest, app.v1.app_pb2.UpdateOrganizationResponse]) → None

async UpdateOrganizationNamespace(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationNamespaceRequest, app.v1.app_pb2.UpdateOrganizationNamespaceResponse]) → None

async DeleteOrganization(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationRequest, app.v1.app_pb2.DeleteOrganizationResponse]) → None

async GetOrganizationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetOrganizationMetadataRequest, app.v1.app_pb2.GetOrganizationMetadataResponse]) → None

async UpdateOrganizationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationMetadataRequest, app.v1.app_pb2.UpdateOrganizationMetadataResponse]) → None

async ListOrganizationMembers(stream: grpclib.server.Stream[app.v1.app_pb2.ListOrganizationMembersRequest, app.v1.app_pb2.ListOrganizationMembersResponse]) → None

async CreateOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOrganizationInviteRequest, app.v1.app_pb2.CreateOrganizationInviteResponse]) → None

async UpdateOrganizationInviteAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsRequest, app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsResponse]) → None

async DeleteOrganizationMember(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationMemberRequest, app.v1.app_pb2.DeleteOrganizationMemberResponse]) → None

async DeleteOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOrganizationInviteRequest, app.v1.app_pb2.DeleteOrganizationInviteResponse]) → None

async ResendOrganizationInvite(stream: grpclib.server.Stream[app.v1.app_pb2.ResendOrganizationInviteRequest, app.v1.app_pb2.ResendOrganizationInviteResponse]) → None

async EnableBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.EnableBillingServiceRequest, app.v1.app_pb2.EnableBillingServiceResponse]) → None

async DisableBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.DisableBillingServiceRequest, app.v1.app_pb2.DisableBillingServiceResponse]) → None

async UpdateBillingService(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateBillingServiceRequest, app.v1.app_pb2.UpdateBillingServiceResponse]) → None

async GetBillingServiceConfig(stream: grpclib.server.Stream[app.v1.app_pb2.GetBillingServiceConfigRequest, app.v1.app_pb2.GetBillingServiceConfigResponse]) → None

async OrganizationSetSupportEmail(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationSetSupportEmailRequest, app.v1.app_pb2.OrganizationSetSupportEmailResponse]) → None

async OrganizationGetSupportEmail(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationGetSupportEmailRequest, app.v1.app_pb2.OrganizationGetSupportEmailResponse]) → None

async OrganizationSetLogo(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationSetLogoRequest, app.v1.app_pb2.OrganizationSetLogoResponse]) → None

async OrganizationGetLogo(stream: grpclib.server.Stream[app.v1.app_pb2.OrganizationGetLogoRequest, app.v1.app_pb2.OrganizationGetLogoResponse]) → None

async EnableAuthService(stream: grpclib.server.Stream[app.v1.app_pb2.EnableAuthServiceRequest, app.v1.app_pb2.EnableAuthServiceResponse]) → None

async DisableAuthService(stream: grpclib.server.Stream[app.v1.app_pb2.DisableAuthServiceRequest, app.v1.app_pb2.DisableAuthServiceResponse]) → None

async CreateOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.CreateOAuthAppRequest, app.v1.app_pb2.CreateOAuthAppResponse]) → None

async ReadOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.ReadOAuthAppRequest, app.v1.app_pb2.ReadOAuthAppResponse]) → None

async UpdateOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateOAuthAppRequest, app.v1.app_pb2.UpdateOAuthAppResponse]) → None

async DeleteOAuthApp(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteOAuthAppRequest, app.v1.app_pb2.DeleteOAuthAppResponse]) → None

async ListOAuthApps(stream: grpclib.server.Stream[app.v1.app_pb2.ListOAuthAppsRequest, app.v1.app_pb2.ListOAuthAppsResponse]) → None

async CreateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationRequest, app.v1.app_pb2.CreateLocationResponse]) → None

async GetLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationRequest, app.v1.app_pb2.GetLocationResponse]) → None

async UpdateLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationRequest, app.v1.app_pb2.UpdateLocationResponse]) → None

async DeleteLocation(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationRequest, app.v1.app_pb2.DeleteLocationResponse]) → None

async GetLocationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetLocationMetadataRequest, app.v1.app_pb2.GetLocationMetadataResponse]) → None

async UpdateLocationMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateLocationMetadataRequest, app.v1.app_pb2.UpdateLocationMetadataResponse]) → None

async ListLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListLocationsRequest, app.v1.app_pb2.ListLocationsResponse]) → None

async ShareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.ShareLocationRequest, app.v1.app_pb2.ShareLocationResponse]) → None

async UnshareLocation(stream: grpclib.server.Stream[app.v1.app_pb2.UnshareLocationRequest, app.v1.app_pb2.UnshareLocationResponse]) → None

async LocationAuth(stream: grpclib.server.Stream[app.v1.app_pb2.LocationAuthRequest, app.v1.app_pb2.LocationAuthResponse]) → None

async CreateLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateLocationSecretRequest, app.v1.app_pb2.CreateLocationSecretResponse]) → None

async DeleteLocationSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteLocationSecretRequest, app.v1.app_pb2.DeleteLocationSecretResponse]) → None

async GetRobot(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotRequest, app.v1.app_pb2.GetRobotResponse]) → None

async GetRobotMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotMetadataRequest, app.v1.app_pb2.GetRobotMetadataResponse]) → None

async UpdateRobotMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotMetadataRequest, app.v1.app_pb2.UpdateRobotMetadataResponse]) → None

async GetRoverRentalRobots(stream: grpclib.server.Stream[app.v1.app_pb2.GetRoverRentalRobotsRequest, app.v1.app_pb2.GetRoverRentalRobotsResponse]) → None

async GetRobotParts(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartsRequest, app.v1.app_pb2.GetRobotPartsResponse]) → None

async GetRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartRequest, app.v1.app_pb2.GetRobotPartResponse]) → None

async GetRobotPartByNameAndLocation(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartByNameAndLocationRequest, app.v1.app_pb2.GetRobotPartByNameAndLocationResponse]) → None

async GetRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartLogsRequest, app.v1.app_pb2.GetRobotPartLogsResponse]) → None

async TailRobotPartLogs(stream: grpclib.server.Stream[app.v1.app_pb2.TailRobotPartLogsRequest, app.v1.app_pb2.TailRobotPartLogsResponse]) → None

async GetRobotPartHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartHistoryRequest, app.v1.app_pb2.GetRobotPartHistoryResponse]) → None

async UpdateRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartRequest, app.v1.app_pb2.UpdateRobotPartResponse]) → None

async NewRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotPartRequest, app.v1.app_pb2.NewRobotPartResponse]) → None

async DeleteRobotPart(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartRequest, app.v1.app_pb2.DeleteRobotPartResponse]) → None

async GetRobotPartMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotPartMetadataRequest, app.v1.app_pb2.GetRobotPartMetadataResponse]) → None

async UpdateRobotPartMetadata(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotPartMetadataRequest, app.v1.app_pb2.UpdateRobotPartMetadataResponse]) → None

async GetRobotAPIKeys(stream: grpclib.server.Stream[app.v1.app_pb2.GetRobotAPIKeysRequest, app.v1.app_pb2.GetRobotAPIKeysResponse]) → None

async MarkPartAsMain(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartAsMainRequest, app.v1.app_pb2.MarkPartAsMainResponse]) → None

async MarkPartForRestart(stream: grpclib.server.Stream[app.v1.app_pb2.MarkPartForRestartRequest, app.v1.app_pb2.MarkPartForRestartResponse]) → None

async CreateRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRobotPartSecretRequest, app.v1.app_pb2.CreateRobotPartSecretResponse]) → None

async DeleteRobotPartSecret(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotPartSecretRequest, app.v1.app_pb2.DeleteRobotPartSecretResponse]) → None

async ListRobots(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsRequest, app.v1.app_pb2.ListRobotsResponse]) → None

async ListRobotsForLocations(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsForLocationsRequest, app.v1.app_pb2.ListRobotsForLocationsResponse]) → None

async ListRobotsForOrg(stream: grpclib.server.Stream[app.v1.app_pb2.ListRobotsForOrgRequest, app.v1.app_pb2.ListRobotsForOrgResponse]) → None

async NewRobot(stream: grpclib.server.Stream[app.v1.app_pb2.NewRobotRequest, app.v1.app_pb2.NewRobotResponse]) → None

async UpdateRobot(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRobotRequest, app.v1.app_pb2.UpdateRobotResponse]) → None

async DeleteRobot(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRobotRequest, app.v1.app_pb2.DeleteRobotResponse]) → None

async ListFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListFragmentsRequest, app.v1.app_pb2.ListFragmentsResponse]) → None

async GetFragment(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentRequest, app.v1.app_pb2.GetFragmentResponse]) → None

async CreateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.CreateFragmentRequest, app.v1.app_pb2.CreateFragmentResponse]) → None

async UpdateFragment(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateFragmentRequest, app.v1.app_pb2.UpdateFragmentResponse]) → None

async DeleteFragment(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentRequest, app.v1.app_pb2.DeleteFragmentResponse]) → None

async ListNestedFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListNestedFragmentsRequest, app.v1.app_pb2.ListNestedFragmentsResponse]) → None

async ListMachineFragments(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineFragmentsRequest, app.v1.app_pb2.ListMachineFragmentsResponse]) → None

async ListMachineSummaries(stream: grpclib.server.Stream[app.v1.app_pb2.ListMachineSummariesRequest, app.v1.app_pb2.ListMachineSummariesResponse]) → None

async GetFragmentHistory(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentHistoryRequest, app.v1.app_pb2.GetFragmentHistoryResponse]) → None

async GetFragmentUsage(stream: grpclib.server.Stream[app.v1.app_pb2.GetFragmentUsageRequest, app.v1.app_pb2.GetFragmentUsageResponse]) → None

async SetFragmentTag(stream: grpclib.server.Stream[app.v1.app_pb2.SetFragmentTagRequest, app.v1.app_pb2.SetFragmentTagResponse]) → None

async DeleteFragmentTag(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteFragmentTagRequest, app.v1.app_pb2.DeleteFragmentTagResponse]) → None

async AddRole(stream: grpclib.server.Stream[app.v1.app_pb2.AddRoleRequest, app.v1.app_pb2.AddRoleResponse]) → None

async RemoveRole(stream: grpclib.server.Stream[app.v1.app_pb2.RemoveRoleRequest, app.v1.app_pb2.RemoveRoleResponse]) → None

async ChangeRole(stream: grpclib.server.Stream[app.v1.app_pb2.ChangeRoleRequest, app.v1.app_pb2.ChangeRoleResponse]) → None

async ListAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.ListAuthorizationsRequest, app.v1.app_pb2.ListAuthorizationsResponse]) → None

async CheckPermissions(stream: grpclib.server.Stream[app.v1.app_pb2.CheckPermissionsRequest, app.v1.app_pb2.CheckPermissionsResponse]) → None

async GetRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.GetRegistryItemRequest, app.v1.app_pb2.GetRegistryItemResponse]) → None

async CreateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.CreateRegistryItemRequest, app.v1.app_pb2.CreateRegistryItemResponse]) → None

async UpdateRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateRegistryItemRequest, app.v1.app_pb2.UpdateRegistryItemResponse]) → None

async ListRegistryItems(stream: grpclib.server.Stream[app.v1.app_pb2.ListRegistryItemsRequest, app.v1.app_pb2.ListRegistryItemsResponse]) → None

async DeleteRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteRegistryItemRequest, app.v1.app_pb2.DeleteRegistryItemResponse]) → None

async RenameRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.RenameRegistryItemRequest, app.v1.app_pb2.RenameRegistryItemResponse]) → None

async TransferRegistryItem(stream: grpclib.server.Stream[app.v1.app_pb2.TransferRegistryItemRequest, app.v1.app_pb2.TransferRegistryItemResponse]) → None

async CreateModule(stream: grpclib.server.Stream[app.v1.app_pb2.CreateModuleRequest, app.v1.app_pb2.CreateModuleResponse]) → None

async UpdateModule(stream: grpclib.server.Stream[app.v1.app_pb2.UpdateModuleRequest, app.v1.app_pb2.UpdateModuleResponse]) → None

async UploadModuleFile(stream: grpclib.server.Stream[app.v1.app_pb2.UploadModuleFileRequest, app.v1.app_pb2.UploadModuleFileResponse]) → None

async GetModule(stream: grpclib.server.Stream[app.v1.app_pb2.GetModuleRequest, app.v1.app_pb2.GetModuleResponse]) → None

async ListModules(stream: grpclib.server.Stream[app.v1.app_pb2.ListModulesRequest, app.v1.app_pb2.ListModulesResponse]) → None

async CreateKey(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyRequest, app.v1.app_pb2.CreateKeyResponse]) → None

async DeleteKey(stream: grpclib.server.Stream[app.v1.app_pb2.DeleteKeyRequest, app.v1.app_pb2.DeleteKeyResponse]) → None

async ListKeys(stream: grpclib.server.Stream[app.v1.app_pb2.ListKeysRequest, app.v1.app_pb2.ListKeysResponse]) → None

async RenameKey(stream: grpclib.server.Stream[app.v1.app_pb2.RenameKeyRequest, app.v1.app_pb2.RenameKeyResponse]) → None

async RotateKey(stream: grpclib.server.Stream[app.v1.app_pb2.RotateKeyRequest, app.v1.app_pb2.RotateKeyResponse]) → None

async CreateKeyFromExistingKeyAuthorizations(stream: grpclib.server.Stream[app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsRequest, app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsResponse]) → None

async GetAppContent(stream: grpclib.server.Stream[app.v1.app_pb2.GetAppContentRequest, app.v1.app_pb2.GetAppContentResponse]) → None

async GetAppBranding(stream: grpclib.server.Stream[app.v1.app_pb2.GetAppBrandingRequest, app.v1.app_pb2.GetAppBrandingResponse]) → None

class viam.proto.app.PKCE

Bases: _PKCE

class viam.proto.app.AdditionalFragment(*, fragment_id: str = ..., version: 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.

fragment_id: str

version: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__version) → _WhichOneofReturnType__version | 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.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.

authorization() → Global___Authorization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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

created_on() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

api_key() → Global___APIKey

authorizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AuthorizationDetails]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.App(*, name: str = ..., type: str = ..., entrypoint: str = ..., fragment_ids: collections.abc.Iterable[str] | None = ..., logo_path: str | None = ..., customizations: Global___AppCustomizations | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

The name of the application

type: str

The type of the application

entrypoint: str

The entrypoint of the application

logo_path: str

path to a custom logo for branding

Type:

Optional

fragment_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional: fragment IDs to filter machines in the picker

customizations() → Global___AppCustomizations

Optional: structured customizations for the app (e.g., machine picker headings)

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__logo_path) → _WhichOneofReturnType__logo_path | 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.AppCustomizations(*, machine_picker: Global___MachinePickerCustomizations | 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_picker() → Global___MachinePickerCustomizations

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.AppType

Bases: _AppType

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

permissions() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.BillingAddress(*, address_line_1: str = ..., address_line_2: str | None = ..., city: str = ..., state: str = ..., zipcode: str = ..., country: str = ...)

Bases: google.protobuf.message.Message

Third Party Org Services

address_line_1: str

address_line_2: str

city: str

state: str

zipcode: str

country: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__address_line_2) → _WhichOneofReturnType__address_line_2 | 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.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.

old_authorization() → Global___Authorization

new_authorization() → Global___Authorization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

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.

authorized_permissions() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AuthorizedPermissions]

class viam.proto.app.ClientAuthentication

Bases: _ClientAuthentication

class viam.proto.app.CreateFragmentRequest(*, name: str = ..., config: google.protobuf.struct_pb2.Struct | None = ..., organization_id: str = ..., visibility: 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.

name: str

organization_id: str

visibility: Global___FragmentVisibility

config() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__visibility) → _WhichOneofReturnType__visibility | 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.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.

fragment() → Global___Fragment

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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

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: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__parent_location_id) → _WhichOneofReturnType__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.

location() → Global___Location

Location object is returned.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

auth() → Global___LocationAuth

Location’s auth after updates.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.CreateOAuthAppRequest(*, org_id: str = ..., client_name: str = ..., oauth_config: Global___OAuthConfig | 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.

org_id: str

client_name: str

oauth_config() → Global___OAuthConfig

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.CreateOAuthAppResponse(*, client_id: str = ..., client_secret: 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.

client_id: str

client_secret: str

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.

authorizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Authorization]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__send_email_invite) → _WhichOneofReturnType__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.

invite() → Global___OrganizationInvite

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

organization() → Global___Organization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.CreateRegistryItemRequest(*, organization_id: str = ..., name: str = ..., type: 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: 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.

part() → Global___RobotPart

Location’s auth after updates.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.DeleteFragmentTagRequest(*, fragment_id: str = ..., tag: 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.

fragment_id: str

tag: str

class viam.proto.app.DeleteFragmentTagResponse(*, tags: collections.abc.Iterable[Global___FragmentTag] | 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.

tags() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentTag]

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.DeleteOAuthAppRequest(*, org_id: str = ..., client_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

client_id: str

class viam.proto.app.DeleteOAuthAppResponse

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.DisableAuthServiceRequest(*, 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.DisableAuthServiceResponse

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.DisableBillingServiceRequest(*, 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.DisableBillingServiceResponse

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.EnableAuthServiceRequest(*, 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.EnableAuthServiceResponse

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.EnableBillingServiceRequest(*, org_id: str = ..., billing_address: Global___BillingAddress | 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.

org_id: str

billing_address() → Global___BillingAddress

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.EnableBillingServiceResponse

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.EnabledGrant

Bases: _EnabledGrant

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 = ..., last_updated: google.protobuf.timestamp_pb2.Timestamp | None = ..., revision: 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

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

revision: str

fragment() → google.protobuf.struct_pb2.Struct

created_on() → google.protobuf.timestamp_pb2.Timestamp

last_updated() → google.protobuf.timestamp_pb2.Timestamp

latest timestamp when fragment was updated

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.FragmentError(*, error_type: Global___FragmentErrorType = ..., fragment_id: str = ..., detail: 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.

error_type: Global___FragmentErrorType

fragment_id: str

detail: str

class viam.proto.app.FragmentErrorType

Bases: _FragmentErrorType

class viam.proto.app.FragmentHistoryEntry(*, fragment: str = ..., edited_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., old: Global___Fragment | None = ..., edited_by: Global___AuthenticatorInfo | None = ..., revision: str = ..., config: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

fragment: str

revision: str

edited_on() → google.protobuf.timestamp_pb2.Timestamp

old() → Global___Fragment

edited_by() → Global___AuthenticatorInfo

config() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.FragmentImport(*, fragment_id: str = ..., version: str = ..., prefix: str | None = ..., variables: collections.abc.Mapping[str, 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.

class VariablesEntry(*, key: str = ..., value: 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

value: str

fragment_id: str

version: str

revision or tag

prefix: str

namespace prefix

variables() → google.protobuf.internal.containers.ScalarMap[str, str]

key-value pairs for fragment variables

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__prefix) → _WhichOneofReturnType__prefix | 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.FragmentImportList(*, fragments: collections.abc.Iterable[Global___FragmentImport] | 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.

fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentImport]

class viam.proto.app.FragmentRevision(*, revision: str = ..., created_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.

revision: str

created_at() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.FragmentSummary(*, 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.FragmentTag(*, tag: str = ..., revision: 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.

tag: str

revision: str

class viam.proto.app.FragmentUsage(*, fragment_id: str = ..., organizations: int = ..., machines: int = ..., machines_in_current_org: int = ..., version: str | None = ...)

Bases: google.protobuf.message.Message

Cached fragment usage statistics

fragment_id: str

organizations: int

machines: int

machines_in_current_org: int

version: str

revision or tag

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__version) → _WhichOneofReturnType__version | 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.FragmentVisibility

Bases: _FragmentVisibility

class viam.proto.app.GetAppBrandingRequest(*, public_namespace: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Branding and customization for app machine picker

public_namespace: str

name: str

class viam.proto.app.GetAppBrandingResponse(*, logo_path: str | None = ..., text_customizations: collections.abc.Mapping[str, Global___TextOverrides] | None = ..., 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.

class TextCustomizationsEntry(*, key: str = ..., value: Global___TextOverrides | 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.

key: str

value() → Global___TextOverrides

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

logo_path: str

text_customizations() → google.protobuf.internal.containers.MessageMap[str, Global___TextOverrides]

fragment_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__logo_path) → _WhichOneofReturnType__logo_path | 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.GetAppContentRequest(*, public_namespace: 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.

public_namespace: str

name: str

class viam.proto.app.GetAppContentResponse(*, blob_path: str = ..., entrypoint: str = ..., app_type: Global___AppType = ..., public: 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.

blob_path: str

entrypoint: str

app_type: Global___AppType

public: bool

class viam.proto.app.GetBillingServiceConfigRequest(*, 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.GetBillingServiceConfigResponse(*, billing_address: Global___BillingAddress | None = ..., support_email: str = ..., logo_url: str = ..., billing_dashboard_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.

support_email: str

logo_url: str

billing_dashboard_url: str

billing_address() → Global___BillingAddress

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__page_limit) → _WhichOneofReturnType__page_limit | None

WhichOneof(oneof_group: _WhichOneofArgType__page_token) → _WhichOneofReturnType__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

history() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentHistoryEntry]

class viam.proto.app.GetFragmentRequest(*, id: str = ..., current_organization_id: str = ..., version: 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

current_organization_id: str

version: str

revision or tag

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__version) → _WhichOneofReturnType__version | 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.GetFragmentResponse(*, fragment: Global___Fragment | None = ..., fragment_usage: Global___FragmentUsage | None = ..., revisions: collections.abc.Iterable[Global___FragmentRevision] | None = ..., tags: collections.abc.Iterable[Global___FragmentTag] | 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() → Global___Fragment

fragment_usage() → Global___FragmentUsage

revisions() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentRevision]

tags() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentTag]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.GetFragmentUsageRequest(*, fragment_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.

fragment_id: str

class viam.proto.app.GetFragmentUsageResponse(*, version_usages: collections.abc.Iterable[Global___FragmentUsage] | 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_usages() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentUsage]

class viam.proto.app.GetLocationMetadataRequest(*, 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.GetLocationMetadataResponse(*, data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

location() → Global___Location

Location object is returned.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.GetModuleRequest(*, module_id: str = ..., include_markdown_documentation: 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.

module_id: str

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

Type:

The id of the module (formatted as prefix

include_markdown_documentation: bool

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__include_markdown_documentation) → _WhichOneofReturnType__include_markdown_documentation | 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.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.

module() → Global___Module

The module object

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.GetOrganizationMetadataRequest(*, 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.GetOrganizationMetadataResponse(*, data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

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

public_namespace: str

organization_id: 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.

organization() → Global___Organization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

organization_identities() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___OrganizationIdentity]

class viam.proto.app.GetRegistryItemRequest(*, item_id: str = ..., include_markdown_documentation: 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.

item_id: str

include_markdown_documentation: bool

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__include_markdown_documentation) → _WhichOneofReturnType__include_markdown_documentation | 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.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.

item() → Global___RegistryItem

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

api_keys() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___APIKeyWithAuthorizations]

class viam.proto.app.GetRobotMetadataRequest(*, 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.GetRobotMetadataResponse(*, data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.GetRobotPartByNameAndLocationRequest(*, name: str = ..., 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.

name: str

location_id: str

class viam.proto.app.GetRobotPartByNameAndLocationResponse(*, 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.

part() → Global___RobotPart

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

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 = ..., start: google.protobuf.timestamp_pb2.Timestamp | None = ..., end: google.protobuf.timestamp_pb2.Timestamp | None = ..., limit: int | None = ..., source: str | None = ..., user_facing_only: 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.

id: str

errors_only() → bool

TODO(https://viam.atlassian.net/browse/APP-3877): Remove this field

filter: str

page_token: str

limit: int

source: str

user_facing_only: bool

levels() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

start() → google.protobuf.timestamp_pb2.Timestamp

end() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__end) → _WhichOneofReturnType__end | None

WhichOneof(oneof_group: _WhichOneofArgType__filter) → _WhichOneofReturnType__filter | None

WhichOneof(oneof_group: _WhichOneofArgType__limit) → _WhichOneofReturnType__limit | None

WhichOneof(oneof_group: _WhichOneofArgType__page_token) → _WhichOneofReturnType__page_token | None

WhichOneof(oneof_group: _WhichOneofArgType__source) → _WhichOneofReturnType__source | None

WhichOneof(oneof_group: _WhichOneofArgType__start) → _WhichOneofReturnType__start | None

WhichOneof(oneof_group: _WhichOneofArgType__user_facing_only) → _WhichOneofReturnType__user_facing_only | 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[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

logs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.LogEntry]

class viam.proto.app.GetRobotPartMetadataRequest(*, 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.GetRobotPartMetadataResponse(*, data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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

part() → Global___RobotPart

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

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.

robot() → Global___Robot

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.

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

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.

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

fragment_visibility() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___FragmentVisibility]

class viam.proto.app.ListFragmentsResponse(*, fragments: collections.abc.Iterable[Global___Fragment] | None = ..., fragment_usages: collections.abc.Iterable[Global___FragmentUsage] | 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.

fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Fragment]

fragment_usages() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentUsage]

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.

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.

locations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Location]

class viam.proto.app.ListMachineFragmentsRequest(*, machine_id: str = ..., additional_fragment_ids: collections.abc.Iterable[str] | None = ..., additional_fragments: collections.abc.Iterable[Global___AdditionalFragment] | 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.

additional_fragment_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

TODO(APP-7642): Mark this field as deprecated

additional_fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AdditionalFragment]

additional fragments 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 = ..., resolved_fragments: collections.abc.Iterable[Global___ResolvedFragment] | 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.

fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Fragment]

resolved_fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResolvedFragment]

class viam.proto.app.ListMachineSummariesRequest(*, organization_id: str = ..., fragment_ids: collections.abc.Iterable[str] | None = ..., location_ids: collections.abc.Iterable[str] | None = ..., 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.

organization_id: str

Optional organization ID. If no value is set it will search among all the organanizations the caller has access to

limit: int

Optional max number of machines to return; default to 100 if unset

fragment_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional list of fragment IDs to filter machines that use any of these fragments

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Optional list of location IDs to filter machines that are in any of these locations.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__limit) → _WhichOneofReturnType__limit | 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.ListMachineSummariesResponse(*, location_summaries: collections.abc.Iterable[Global___LocationSummary] | 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.

location_summaries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___LocationSummary]

class viam.proto.app.ListModulesRequest(*, organization_id: str | None = ..., include_markdown_documentation: 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

The id of the organization to return private modules for.

include_markdown_documentation: bool

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__include_markdown_documentation) → _WhichOneofReturnType__include_markdown_documentation | None

WhichOneof(oneof_group: _WhichOneofArgType__organization_id) → _WhichOneofReturnType__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.

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.ListNestedFragmentsRequest(*, fragment_id: str | None = ..., additional_fragments: collections.abc.Iterable[Global___AdditionalFragment] | 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_id: str

additional_fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AdditionalFragment]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__fragment_id) → _WhichOneofReturnType__fragment_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.ListNestedFragmentsResponse(*, fragments: collections.abc.Iterable[Global___Fragment] | None = ..., resolved_fragments: collections.abc.Iterable[Global___ResolvedFragment] | 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.

fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Fragment]

resolved_fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResolvedFragment]

class viam.proto.app.ListOAuthAppsRequest(*, 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.ListOAuthAppsResponse(*, client_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.

client_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

members() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___OrganizationMember]

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.

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.

organizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Organization]

class viam.proto.app.ListRegistryItemsRequest(*, organization_id: str | None = ..., types: collections.abc.Iterable[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 = ..., include_markdown_documentation: bool | None = ..., module_source_types: collections.abc.Iterable[Global___ModuleSourceType] | None = ..., module_languages: collections.abc.Iterable[Global___ModuleLanguage] | 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

include_markdown_documentation: bool

types() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[app.packages.v1.packages_pb2.PackageType.ValueType]

visibilities() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___Visibility]

platforms() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

statuses() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___RegistryItemStatus]

public_namespaces() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

One or more public namespaces to return results for.

module_source_types() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___ModuleSourceType]

module_languages() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___ModuleLanguage]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__include_markdown_documentation) → _WhichOneofReturnType__include_markdown_documentation | None

WhichOneof(oneof_group: _WhichOneofArgType__organization_id) → _WhichOneofReturnType__organization_id | None

WhichOneof(oneof_group: _WhichOneofArgType__page_token) → _WhichOneofReturnType__page_token | None

WhichOneof(oneof_group: _WhichOneofArgType__search_term) → _WhichOneofReturnType__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.

items() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RegistryItem]

class viam.proto.app.ListRobotsForLocationsRequest(*, location_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.

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.ListRobotsForLocationsResponse(*, 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.

robots() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Robot]

class viam.proto.app.ListRobotsForOrgRequest(*, 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.ListRobotsForOrgResponse(*, 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.

robots() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Robot]

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.

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 = ..., primary_org_identity: 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.

id: str

Location ID.

name: str

Location name.

parent_location_id: str

Location ID of the parent location.

robot_count: int

auth() → Global___LocationAuth

Location authentication secrets.

organizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___LocationOrganization]

Organizations that the location is shared with.

created_on() → google.protobuf.timestamp_pb2.Timestamp

Location creation timestamp.

config() → Global___StorageConfig

Config for how data in this location is stored.

primary_org_identity() → Global___OrganizationIdentity

The organization that is the primary owner of the location.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__primary_org_identity) → _WhichOneofReturnType__primary_org_identity | 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.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

Deprecated: use secrets field.

location_id: str

Location ID containing this LocationAuth.

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.

auth() → Global___LocationAuth

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.LocationSummary(*, location_id: str = ..., location_name: str = ..., machine_summaries: collections.abc.Iterable[Global___MachineSummary] | 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.

location_id: str

location_name: str

machine_summaries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___MachineSummary]

class viam.proto.app.MachinePickerCustomizations(*, heading: str | None = ..., subheading: 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.

heading: str

subheading: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__heading) → _WhichOneofReturnType__heading | None

WhichOneof(oneof_group: _WhichOneofArgType__subheading) → _WhichOneofReturnType__subheading | 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.MachineSummary(*, machine_id: str = ..., machine_name: str = ..., part_summaries: collections.abc.Iterable[Global___PartSummary] | 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

machine_name: str

part_summaries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PartSummary]

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: app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType = ..., detailed_versions: collections.abc.Iterable[Global___MLModelVersion] | 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.

model_type: app.mltraining.v1.ml_training_pb2.ModelType.ValueType

model_framework: app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType

versions() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

A list of package versions for a ML model

detailed_versions() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___MLModelVersion]

class viam.proto.app.MLModelVersion(*, 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

created_on() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

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

model_framework: app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType

draft: bool

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

created_on() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.Model(*, api: str = ..., model: str = ..., markdown_documentation: str | None = ..., description: str | None = ..., supported_hardware: 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.

api: str

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

model: str

The colon-delimited-triplet of the model

markdown_documentation: str

The markdown content describing the usage of the model

description: str

A short description of the model that explains its purpose

supported_hardware() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

A list of supported hardware names

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__description) → _WhichOneofReturnType__description | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_documentation) → _WhichOneofReturnType__markdown_documentation | 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.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 = ..., first_run: str | None = ..., markdown_description: str | None = ..., apps: collections.abc.Iterable[Global___App] | 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.

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

first_run: str

The path to a setup script that is run before a newly downloaded module starts.

markdown_description: str

Longer documentation provided in markdown format

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

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

A list of models that are available in the module

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__first_run) → _WhichOneofReturnType__first_run | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | 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.ModuleFileInfo(*, module_id: str = ..., version: str = ..., platform: str = ..., platform_tags: 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.

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

platform_tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Platform tag constraints. When a robot requests its config, it uploads a platform and a list of platform tags. The platform is checked against platform above, and the tags are checked against this list.

class viam.proto.app.ModuleLanguage

Bases: _ModuleLanguage

class viam.proto.app.ModuleMetadata(*, models: collections.abc.Iterable[Global___Model] | None = ..., versions: collections.abc.Iterable[Global___ModuleVersion] | None = ..., entrypoint: str = ..., first_run: str | None = ..., markdown_description: str | None = ..., apps: collections.abc.Iterable[Global___App] | None = ..., source_type: Global___ModuleSourceType | None = ..., language: Global___ModuleLanguage | 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.

entrypoint: str

The executable to run to start the module program

first_run: str

The path to a setup script that is run before a newly downloaded module starts.

markdown_description: str

markdown content for the entire module

source_type: Global___ModuleSourceType

Determines the type of module, either a registry module or an inline module.

language: Global___ModuleLanguage

Specifies the language that the module is written in.

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

A list of models that are available in the module

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

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__first_run) → _WhichOneofReturnType__first_run | None

WhichOneof(oneof_group: _WhichOneofArgType__language) → _WhichOneofReturnType__language | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | None

WhichOneof(oneof_group: _WhichOneofArgType__source_type) → _WhichOneofReturnType__source_type | 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.ModuleSourceType

Bases: _ModuleSourceType

class viam.proto.app.ModuleVersion(*, version: str = ..., files: collections.abc.Iterable[Global___Uploads] | None = ..., models: collections.abc.Iterable[Global___Model] | None = ..., entrypoint: str = ..., first_run: str | None = ..., markdown_description: str | None = ..., apps: collections.abc.Iterable[Global___App] | 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

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

entrypoint: str

The entrypoint for this version of the module

first_run: str

The path to a setup script that is run before a newly downloaded module starts.

markdown_description: str

The markdown documentation for this version of the module

files() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Uploads]

The uploads that are available for this module version

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

The models that this verion of the module provides

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__first_run) → _WhichOneofReturnType__first_run | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | 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.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.OAuthConfig(*, client_authentication: Global___ClientAuthentication = ..., pkce: Global___PKCE = ..., url_validation: Global___URLValidation = ..., origin_uris: collections.abc.Iterable[str] | None = ..., redirect_uris: collections.abc.Iterable[str] | None = ..., logout_uri: str = ..., enabled_grants: collections.abc.Iterable[Global___EnabledGrant] | None = ..., invite_redirect_uri: 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.

client_authentication: Global___ClientAuthentication

pkce: Global___PKCE

url_validation: Global___URLValidation

logout_uri: str

invite_redirect_uri: str

origin_uris() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

redirect_uris() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

enabled_grants() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___EnabledGrant]

class viam.proto.app.OnlineState

Bases: _OnlineState

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 = ..., default_fragments: Global___FragmentImportList | 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

created_on() → google.protobuf.timestamp_pb2.Timestamp

default_fragments() → Global___FragmentImportList

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__cid) → _WhichOneofReturnType__cid | None

WhichOneof(oneof_group: _WhichOneofArgType__default_fragments) → _WhichOneofReturnType__default_fragments | 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.OrganizationGetLogoRequest(*, 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.OrganizationGetLogoResponse(*, 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.

url: str

class viam.proto.app.OrganizationGetSupportEmailRequest(*, 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.OrganizationGetSupportEmailResponse(*, 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.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

created_on() → google.protobuf.timestamp_pb2.Timestamp

authorizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Authorization]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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 = ..., last_access: 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

emails() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

date_added() → google.protobuf.timestamp_pb2.Timestamp

last_login() → google.protobuf.timestamp_pb2.Timestamp

last_access() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__last_access) → _WhichOneofReturnType__last_access | None

WhichOneof(oneof_group: _WhichOneofArgType__last_login) → _WhichOneofReturnType__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.OrganizationSetLogoRequest(*, org_id: str = ..., logo: bytes = ...)

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

logo: bytes

class viam.proto.app.OrganizationSetLogoResponse

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.OrganizationSetSupportEmailRequest(*, org_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.

org_id: str

email: str

class viam.proto.app.OrganizationSetSupportEmailResponse

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.OrgDetails(*, org_id: str = ..., org_name: str = ..., org_cid: str | None = ..., public_namespace: str | None = ..., billing_tier: 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.

org_id: str

org_name: str

org_cid: str

public_namespace: str

billing_tier: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__billing_tier) → _WhichOneofReturnType__billing_tier | None

WhichOneof(oneof_group: _WhichOneofArgType__org_cid) → _WhichOneofReturnType__org_cid | None

WhichOneof(oneof_group: _WhichOneofArgType__public_namespace) → _WhichOneofReturnType__public_namespace | 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.PartSummary(*, part_id: str = ..., part_name: str = ..., is_main_part: bool = ..., online_state: Global___OnlineState = ..., seconds_since_online: int = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., last_online: google.protobuf.timestamp_pb2.Timestamp | None = ..., viam_server_version: Global___ViamServerVersion | None = ..., viam_agent_version: Global___ViamAgentVersion | None = ..., os: str | None = ..., platform: str | None = ..., public_ip_address: str | None = ..., dns_name: str | None = ..., fragments: collections.abc.Iterable[Global___FragmentSummary] | 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_id: str

part_name: str

is_main_part: bool

online_state: Global___OnlineState

seconds_since_online: int

os: str

platform: str

public_ip_address: str

dns_name: str

last_access() → google.protobuf.timestamp_pb2.Timestamp

last_online() → google.protobuf.timestamp_pb2.Timestamp

viam_server_version() → Global___ViamServerVersion

viam_agent_version() → Global___ViamAgentVersion

fragments() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentSummary]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__dns_name) → _WhichOneofReturnType__dns_name | None

WhichOneof(oneof_group: _WhichOneofArgType__last_access) → _WhichOneofReturnType__last_access | None

WhichOneof(oneof_group: _WhichOneofArgType__last_online) → _WhichOneofReturnType__last_online | None

WhichOneof(oneof_group: _WhichOneofArgType__os) → _WhichOneofReturnType__os | None

WhichOneof(oneof_group: _WhichOneofArgType__platform) → _WhichOneofReturnType__platform | None

WhichOneof(oneof_group: _WhichOneofArgType__public_ip_address) → _WhichOneofReturnType__public_ip_address | None

WhichOneof(oneof_group: _WhichOneofArgType__viam_agent_version) → _WhichOneofReturnType__viam_agent_version | None

WhichOneof(oneof_group: _WhichOneofArgType__viam_server_version) → _WhichOneofReturnType__viam_server_version | 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.ReadOAuthAppRequest(*, org_id: str = ..., client_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

client_id: str

class viam.proto.app.ReadOAuthAppResponse(*, client_name: str = ..., client_secret: str = ..., oauth_config: Global___OAuthConfig | 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.

client_name: str

client_secret: str

oauth_config() → Global___OAuthConfig

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.RegistryItem(*, item_id: str = ..., organization_id: str = ..., public_namespace: str = ..., name: str = ..., type: 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: 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

module_metadata() → Global___ModuleMetadata

ml_model_metadata() → Global___MLModelMetadata

ml_training_metadata() → Global___MLTrainingMetadata

created_at() → google.protobuf.timestamp_pb2.Timestamp

When the item was created

updated_at() → google.protobuf.timestamp_pb2.Timestamp

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

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_metadata) → _WhichOneofReturnType_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.

authorization() → Global___Authorization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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.RenameRegistryItemRequest(*, item_id: str = ..., new_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.

item_id: str

new_name: str

class viam.proto.app.RenameRegistryItemResponse(*, 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.

item() → Global___RegistryItem

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.ResendOrganizationInviteRequest(*, organization_id: str = ..., email: str = ..., 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.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__send_email_invite) → _WhichOneofReturnType__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.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.

invite() → Global___OrganizationInvite

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.ResolvedFragment(*, fragment_id: str = ..., resolved_config: google.protobuf.struct_pb2.Struct | None = ..., error: Global___FragmentError | None = ..., revision: 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.

fragment_id: str

revision: str

resolved_config() → google.protobuf.struct_pb2.Struct

error() → Global___FragmentError

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.Robot(*, id: str = ..., name: str = ..., location: str = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., online_state: Global___OnlineState = ..., seconds_since_online: int = ...)

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

online_state: Global___OnlineState

seconds_since_online: int

last_access() → google.protobuf.timestamp_pb2.Timestamp

created_on() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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 = ..., last_updated: google.protobuf.timestamp_pb2.Timestamp | None = ..., online_state: Global___OnlineState = ..., seconds_since_online: int = ...)

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

online_state: Global___OnlineState

seconds_since_online: int

robot_config() → google.protobuf.struct_pb2.Struct

last_access() → google.protobuf.timestamp_pb2.Timestamp

user_supplied_info() → google.protobuf.struct_pb2.Struct

created_on() → google.protobuf.timestamp_pb2.Timestamp

secrets() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___SharedSecret]

List of secrets allowed for authentication.

last_updated() → google.protobuf.timestamp_pb2.Timestamp

latest timestamp when a robot part was updated

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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

when() → google.protobuf.timestamp_pb2.Timestamp

old() → Global___RobotPart

edited_by() → Global___AuthenticatorInfo

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.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

class viam.proto.app.RoverRentalRobot(*, robot_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_main_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.

robot_id: str

location_id: str

robot_name: str

robot_main_part_id: str

class viam.proto.app.SearchOrganizationsRequest(*, org_id: str | None = ..., org_name: str | None = ..., cid: str | None = ..., public_namespace: 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.

org_id: str

org_name: str

cid: str

public_namespace: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__cid) → _WhichOneofReturnType__cid | None

WhichOneof(oneof_group: _WhichOneofArgType__org_id) → _WhichOneofReturnType__org_id | None

WhichOneof(oneof_group: _WhichOneofArgType__org_name) → _WhichOneofReturnType__org_name | None

WhichOneof(oneof_group: _WhichOneofArgType__public_namespace) → _WhichOneofReturnType__public_namespace | 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.SearchOrganizationsResponse(*, organizations: 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.

organizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___OrgDetails]

class viam.proto.app.SetFragmentTagRequest(*, fragment_id: str = ..., tag: str = ..., revision: 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.

fragment_id: str

tag: str

revision: str

class viam.proto.app.SetFragmentTagResponse(*, tags: collections.abc.Iterable[Global___FragmentTag] | 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.

tags() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FragmentTag]

class viam.proto.app.SharedSecret(*, id: str = ..., secret: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., state: Global___SharedSecret = ...)

Bases: google.protobuf.message.Message

SharedSecret is a secret used for LocationAuth and RobotParts.

class State

Bases: _State

STATE_UNSPECIFIED: SharedSecret

STATE_ENABLED: SharedSecret

Secret is enabled and can be used in authentication.

STATE_DISABLED: SharedSecret

Secret is disabled and must not be used to authenticate to rpc.

id: str

secret: str

The payload of the secret. Used during authentication to the rpc framework.

state: Global___SharedSecret.State.ValueType

State of the shared secret. In most cases it should be enabled. We may support disabling a specific secret while keeping it in the database.

created_on() → google.protobuf.timestamp_pb2.Timestamp

Date/time the secret was first created.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.ShareLocationRequest(*, location_id: str = ..., 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.

location_id: str

Location ID to be shared.

organization_id: str

Organization ID to share the location with.

class viam.proto.app.ShareLocationResponse

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.StorageConfig(*, region: 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.

region: str

GCS region that data is stored in.

class viam.proto.app.TailRobotPartLogsRequest(*, id: str = ..., errors_only: bool = ..., filter: 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

filter: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__filter) → _WhichOneofReturnType__filter | 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.TailRobotPartLogsResponse(*, logs: collections.abc.Iterable[common.v1.common_pb2.LogEntry] | 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.

logs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.LogEntry]

class viam.proto.app.TextOverrides(*, fields: collections.abc.Mapping[str, 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.

class FieldsEntry(*, key: str = ..., value: 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

value: str

fields() → google.protobuf.internal.containers.ScalarMap[str, str]

class viam.proto.app.TransferRegistryItemRequest(*, item_id: str = ..., new_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.

item_id: str

new_public_namespace: str

class viam.proto.app.TransferRegistryItemResponse

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.UnshareLocationRequest(*, location_id: str = ..., 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.

location_id: str

Location ID to be unshared.

organization_id: str

Organization ID to unshare the location with.

class viam.proto.app.UnshareLocationResponse

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.UpdateBillingServiceRequest(*, org_id: str = ..., billing_address: Global___BillingAddress | 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.

org_id: str

billing_address() → Global___BillingAddress

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateBillingServiceResponse

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.UpdateFragmentRequest(*, id: str = ..., name: str = ..., config: google.protobuf.struct_pb2.Struct | None = ..., public: bool | None = ..., visibility: Global___FragmentVisibility | None = ..., last_known_update: 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

public: bool

visibility: Global___FragmentVisibility

config() → google.protobuf.struct_pb2.Struct

last_known_update() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__last_known_update) → _WhichOneofReturnType__last_known_update | None

WhichOneof(oneof_group: _WhichOneofArgType__public) → _WhichOneofReturnType__public | None

WhichOneof(oneof_group: _WhichOneofArgType__visibility) → _WhichOneofReturnType__visibility | 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.UpdateFragmentResponse(*, 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.

fragment() → Global___Fragment

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateLocationMetadataRequest(*, location_id: str = ..., data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateLocationMetadataResponse

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.UpdateLocationRequest(*, location_id: str = ..., name: str | None = ..., parent_location_id: str | None = ..., region: 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.

location_id: str

Location ID of location to update.

name: str

The new name to be updated on location.

parent_location_id: str

The new parent location to move the location under.

region: str

The new GCS region to associate the location with.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__name) → _WhichOneofReturnType__name | None

WhichOneof(oneof_group: _WhichOneofArgType__parent_location_id) → _WhichOneofReturnType__parent_location_id | None

WhichOneof(oneof_group: _WhichOneofArgType__region) → _WhichOneofReturnType__region | 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.UpdateLocationResponse(*, 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.

location() → Global___Location

Location object is returned.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateMLModelMetadata(*, model_type: app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: 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: app.mltraining.v1.ml_training_pb2.ModelType.ValueType

model_framework: app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType

class viam.proto.app.UpdateMLTrainingMetadata(*, model_type: app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: 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: app.mltraining.v1.ml_training_pb2.ModelType.ValueType

model_framework: app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType

draft: bool

class viam.proto.app.UpdateModuleMetadata(*, models: collections.abc.Iterable[Global___Model] | None = ..., entrypoint: str = ..., apps: collections.abc.Iterable[Global___App] | None = ..., source_type: Global___ModuleSourceType | None = ..., language: Global___ModuleLanguage | 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.

entrypoint: str

The executable to run to start the module program

source_type: Global___ModuleSourceType

Determines where the source code of module is managed, either externally or hosted by viam.

language: Global___ModuleLanguage

The language the module is written in

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

A list of models that are available in the module

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__language) → _WhichOneofReturnType__language | None

WhichOneof(oneof_group: _WhichOneofArgType__source_type) → _WhichOneofReturnType__source_type | 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.UpdateModuleRequest(*, module_id: str = ..., visibility: Global___Visibility = ..., url: str = ..., description: str = ..., models: collections.abc.Iterable[Global___Model] | None = ..., entrypoint: str = ..., first_run: str | None = ..., apps: collections.abc.Iterable[Global___App] | None = ..., markdown_description: 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.

module_id: str

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

Type:

The id of the module (formatted as prefix

visibility: Global___Visibility

The visibility that should be set for the module

url: str

The url to reference for documentation, code, etc.

description: str

A short description of the module that explains its purpose

entrypoint: str

The executable to run to start the module program

first_run: str

The path to a setup script that is run before a newly downloaded module starts.

markdown_description: str

longer documentation provided in markdown format

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

A list of models that are available in the module

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__first_run) → _WhichOneofReturnType__first_run | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | 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.UpdateModuleResponse(*, 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.

url: str

The detail page of the module

class viam.proto.app.UpdateOAuthAppRequest(*, org_id: str = ..., client_id: str = ..., client_name: str = ..., oauth_config: Global___OAuthConfig | 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.

org_id: str

client_id: str

client_name: str

oauth_config() → Global___OAuthConfig

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateOAuthAppResponse

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.UpdateOrganizationInviteAuthorizationsRequest(*, organization_id: str = ..., email: str = ..., add_authorizations: collections.abc.Iterable[Global___Authorization] | None = ..., remove_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

add_authorizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Authorization]

remove_authorizations() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Authorization]

class viam.proto.app.UpdateOrganizationInviteAuthorizationsResponse(*, 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.

invite() → Global___OrganizationInvite

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateOrganizationMetadataRequest(*, organization_id: str = ..., data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateOrganizationMetadataResponse

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.UpdateOrganizationNamespaceRequest(*, organization_id: str = ..., new_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.

organization_id: str

new_public_namespace: str

class viam.proto.app.UpdateOrganizationNamespaceResponse(*, 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.

organization() → Global___Organization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateOrganizationRequest(*, organization_id: str = ..., name: str | None = ..., public_namespace: str | None = ..., region: str | None = ..., cid: str | None = ..., default_fragments: Global___FragmentImportList | 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

name: str

public_namespace: str

region: str

The new GCS region to associate the org with.

cid: str

default_fragments() → Global___FragmentImportList

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__cid) → _WhichOneofReturnType__cid | None

WhichOneof(oneof_group: _WhichOneofArgType__default_fragments) → _WhichOneofReturnType__default_fragments | None

WhichOneof(oneof_group: _WhichOneofArgType__name) → _WhichOneofReturnType__name | None

WhichOneof(oneof_group: _WhichOneofArgType__public_namespace) → _WhichOneofReturnType__public_namespace | None

WhichOneof(oneof_group: _WhichOneofArgType__region) → _WhichOneofReturnType__region | 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.UpdateOrganizationResponse(*, 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.

organization() → Global___Organization

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateRegistryItemRequest(*, item_id: str = ..., type: app.packages.v1.packages_pb2.PackageType.ValueType = ..., description: str = ..., visibility: Global___Visibility = ..., url: str | None = ..., update_module_metadata: Global___UpdateModuleMetadata | None = ..., update_ml_model_metadata: Global___UpdateMLModelMetadata | None = ..., update_ml_training_metadata: Global___UpdateMLTrainingMetadata | None = ..., markdown_description: 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.

item_id: str

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

description: str

visibility: Global___Visibility

url: str

markdown_description: str

update_module_metadata() → Global___UpdateModuleMetadata

update_ml_model_metadata() → Global___UpdateMLModelMetadata

update_ml_training_metadata() → Global___UpdateMLTrainingMetadata

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | None

WhichOneof(oneof_group: _WhichOneofArgType__url) → _WhichOneofReturnType__url | None

WhichOneof(oneof_group: _WhichOneofArgType_metadata) → _WhichOneofReturnType_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.UpdateRegistryItemResponse

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.UpdateRobotMetadataRequest(*, id: str = ..., data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateRobotMetadataResponse

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.UpdateRobotPartMetadataRequest(*, id: str = ..., data: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

data() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UpdateRobotPartMetadataResponse

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.UpdateRobotPartRequest(*, id: str = ..., name: str = ..., robot_config: google.protobuf.struct_pb2.Struct | None = ..., last_known_update: 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

robot_config() → google.protobuf.struct_pb2.Struct

last_known_update() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__last_known_update) → _WhichOneofReturnType__last_known_update | 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.UpdateRobotPartResponse(*, 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.

part() → Global___RobotPart

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

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

id: str

name: str

location: str

class viam.proto.app.UpdateRobotResponse(*, 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.

robot() → Global___Robot

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.UploadModuleFileRequest(*, module_file_info: Global___ModuleFileInfo | None = ..., file: bytes = ...)

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.

file: bytes

The file contents to be uploaded

module_file_info() → Global___ModuleFileInfo

The information about the module file being uploaded

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_module_file) → _WhichOneofReturnType_module_file | 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.UploadModuleFileResponse(*, 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.

url: str

The detail page of the module

class viam.proto.app.Uploads(*, platform: str = ..., uploaded_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.

platform: str

The OS and architecture the module is built to run on

uploaded_at() → google.protobuf.timestamp_pb2.Timestamp

The time when the file was uploaded

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.URLValidation

Bases: _URLValidation

class viam.proto.app.VersionHistory(*, version: str = ..., files: collections.abc.Iterable[Global___Uploads] | None = ..., models: collections.abc.Iterable[Global___Model] | None = ..., entrypoint: str = ..., first_run: str | None = ..., markdown_description: str | None = ..., apps: collections.abc.Iterable[Global___App] | 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

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

entrypoint: str

The entrypoint for this version of the module

first_run: str

The path to a setup script that is run before a newly downloaded module starts.

markdown_description: str

The markdown documentation for this version of the module

files() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Uploads]

The uploads that are available for this module version

models() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Model]

The models that this verion of the module provides

apps() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___App]

A list of applications associated with the module

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__first_run) → _WhichOneofReturnType__first_run | None

WhichOneof(oneof_group: _WhichOneofArgType__markdown_description) → _WhichOneofReturnType__markdown_description | 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.ViamAgentVersion(*, major: str = ..., minor: 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.

major: str

minor: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_version) → _WhichOneofReturnType_version | 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.ViamServerVersion(*, major: str = ..., minor: 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.

major: str

minor: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType_version) → _WhichOneofReturnType_version | 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.Visibility

Bases: _Visibility