viam.gen.app.v1.app_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`ONLINE_STATE_UNSPECIFIED`
`ONLINE_STATE_ONLINE`
`ONLINE_STATE_OFFLINE`
`ONLINE_STATE_AWAITING_SETUP`
`Global___OnlineState`
`AUTHENTICATION_TYPE_UNSPECIFIED`
`AUTHENTICATION_TYPE_WEB_OAUTH`
`AUTHENTICATION_TYPE_API_KEY`
`AUTHENTICATION_TYPE_ROBOT_PART_SECRET`
`AUTHENTICATION_TYPE_LOCATION_SECRET`
`Global___AuthenticationType`
`FRAGMENT_VISIBILITY_UNSPECIFIED`
`FRAGMENT_VISIBILITY_PRIVATE`
`FRAGMENT_VISIBILITY_PUBLIC`
`FRAGMENT_VISIBILITY_PUBLIC_UNLISTED`
`Global___FragmentVisibility`
`FRAGMENT_ERROR_TYPE_UNSPECIFIED`
`FRAGMENT_ERROR_TYPE_NO_ACCESS`
`FRAGMENT_ERROR_TYPE_NESTING_LIMIT_EXCEEDED`
`FRAGMENT_ERROR_TYPE_CHILD_ID_INVALID`
`FRAGMENT_ERROR_TYPE_CYCLE_DETECTED`
`Global___FragmentErrorType`
`MODULE_SOURCE_TYPE_UNSPECIFIED`
`MODULE_SOURCE_TYPE_EXTERNAL`	Module source code is stored externally, such as in github.
`MODULE_SOURCE_TYPE_VIAM_HOSTED`	Module source code is versioned and managed within Viam.
`Global___ModuleSourceType`
`MODULE_LANGUAGE_UNSPECIFIED`
`MODULE_LANGUAGE_GOLANG`
`MODULE_LANGUAGE_PYTHON`
`MODULE_LANGUAGE_CPP`
`Global___ModuleLanguage`
`REGISTRY_ITEM_STATUS_UNSPECIFIED`
`REGISTRY_ITEM_STATUS_PUBLISHED`
`REGISTRY_ITEM_STATUS_IN_DEVELOPMENT`
`Global___RegistryItemStatus`
`VISIBILITY_UNSPECIFIED`
`VISIBILITY_PRIVATE`	Private registry items are visible only within the owning org
`VISIBILITY_PUBLIC`	Public registry items are visible to everyone
`VISIBILITY_PUBLIC_UNLISTED`	Public Unlisted registry items are usable in everyone's robot but are hidden from the registry page as if they are private
`Global___Visibility`
`APP_TYPE_UNSPECIFIED`
`APP_TYPE_SINGLE_MACHINE`
`APP_TYPE_MULTI_MACHINE`
`Global___AppType`
`CLIENT_AUTHENTICATION_UNSPECIFIED`
`CLIENT_AUTHENTICATION_REQUIRED`
`CLIENT_AUTHENTICATION_NOT_REQUIRED`
`CLIENT_AUTHENTICATION_NOT_REQUIRED_WHEN_USING_PKCE`
`Global___ClientAuthentication`
`PKCE_UNSPECIFIED`
`PKCE_REQUIRED`
`PKCE_NOT_REQUIRED`
`PKCE_NOT_REQUIRED_WHEN_USING_CLIENT_AUTHENTICATION`
`Global___PKCE`
`URL_VALIDATION_UNSPECIFIED`
`URL_VALIDATION_EXACT_MATCH`
`URL_VALIDATION_ALLOW_WILDCARDS`
`Global___URLValidation`
`ENABLED_GRANT_UNSPECIFIED`
`ENABLED_GRANT_AUTHORIZATION_CODE`
`ENABLED_GRANT_IMPLICIT`
`ENABLED_GRANT_PASSWORD`
`ENABLED_GRANT_REFRESH_TOKEN`
`ENABLED_GRANT_DEVICE_CODE`
`Global___EnabledGrant`
`Global___Robot`
`Global___RobotPart`
`Global___RobotPartHistoryEntry`
`Global___AuthenticatorInfo`
`Global___ListOrganizationsRequest`
`Global___Organization`
`Global___OrganizationMember`
`Global___ListOrganizationsResponse`
`Global___OrganizationInvite`
`Global___CreateOrganizationRequest`
`Global___CreateOrganizationResponse`
`Global___GetOrganizationRequest`
`Global___GetOrganizationResponse`
`Global___GetOrganizationNamespaceAvailabilityRequest`
`Global___GetOrganizationNamespaceAvailabilityResponse`
`Global___FragmentImportList`
`Global___UpdateOrganizationRequest`
`Global___UpdateOrganizationResponse`
`Global___UpdateOrganizationNamespaceRequest`
`Global___UpdateOrganizationNamespaceResponse`
`Global___DeleteOrganizationRequest`
`Global___DeleteOrganizationResponse`
`Global___GetOrganizationMetadataRequest`
`Global___GetOrganizationMetadataResponse`
`Global___UpdateOrganizationMetadataRequest`
`Global___UpdateOrganizationMetadataResponse`
`Global___ListOrganizationMembersRequest`
`Global___ListOrganizationMembersResponse`
`Global___CreateOrganizationInviteRequest`
`Global___CreateOrganizationInviteResponse`
`Global___UpdateOrganizationInviteAuthorizationsRequest`
`Global___UpdateOrganizationInviteAuthorizationsResponse`
`Global___DeleteOrganizationInviteRequest`
`Global___DeleteOrganizationInviteResponse`
`Global___ResendOrganizationInviteRequest`
`Global___ResendOrganizationInviteResponse`
`Global___DeleteOrganizationMemberRequest`
`Global___DeleteOrganizationMemberResponse`
`Global___BillingAddress`
`Global___EnableBillingServiceRequest`
`Global___EnableBillingServiceResponse`
`Global___UpdateBillingServiceRequest`
`Global___UpdateBillingServiceResponse`
`Global___GetBillingServiceConfigRequest`
`Global___GetBillingServiceConfigResponse`
`Global___DisableBillingServiceRequest`
`Global___DisableBillingServiceResponse`
`Global___OrganizationSetSupportEmailRequest`
`Global___OrganizationSetSupportEmailResponse`
`Global___OrganizationGetSupportEmailRequest`
`Global___OrganizationGetSupportEmailResponse`
`Global___OrganizationIdentity`
`Global___LocationOrganization`
`Global___LocationAuth`
`Global___StorageConfig`
`Global___Location`
`Global___SharedSecret`
`Global___CreateLocationRequest`
`Global___CreateLocationResponse`
`Global___GetLocationRequest`
`Global___GetLocationResponse`
`Global___UpdateLocationRequest`
`Global___UpdateLocationResponse`
`Global___DeleteLocationRequest`
`Global___DeleteLocationResponse`
`Global___GetLocationMetadataRequest`
`Global___GetLocationMetadataResponse`
`Global___UpdateLocationMetadataRequest`
`Global___UpdateLocationMetadataResponse`
`Global___GetOrganizationsWithAccessToLocationRequest`
`Global___GetOrganizationsWithAccessToLocationResponse`
`Global___ListLocationsRequest`
`Global___ShareLocationRequest`
`Global___ShareLocationResponse`
`Global___UnshareLocationRequest`
`Global___UnshareLocationResponse`
`Global___ListLocationsResponse`
`Global___CreateLocationSecretRequest`
`Global___CreateLocationSecretResponse`
`Global___DeleteLocationSecretRequest`
`Global___DeleteLocationSecretResponse`
`Global___LocationAuthRequest`
`Global___LocationAuthResponse`
`Global___GetRobotRequest`
`Global___GetRoverRentalRobotsRequest`
`Global___RoverRentalRobot`
`Global___GetRoverRentalRobotsResponse`
`Global___GetRobotResponse`
`Global___GetRobotPartsRequest`
`Global___GetRobotPartsResponse`
`Global___GetRobotPartRequest`
`Global___GetRobotPartResponse`
`Global___GetRobotPartByNameAndLocationRequest`
`Global___GetRobotPartByNameAndLocationResponse`
`Global___GetRobotPartLogsRequest`
`Global___GetRobotPartLogsResponse`
`Global___TailRobotPartLogsRequest`
`Global___TailRobotPartLogsResponse`
`Global___GetRobotPartHistoryRequest`
`Global___GetRobotPartHistoryResponse`
`Global___UpdateRobotPartRequest`
`Global___UpdateRobotPartResponse`
`Global___NewRobotPartRequest`
`Global___NewRobotPartResponse`
`Global___DeleteRobotPartRequest`
`Global___GetRobotPartMetadataRequest`
`Global___GetRobotPartMetadataResponse`
`Global___UpdateRobotPartMetadataRequest`
`Global___UpdateRobotPartMetadataResponse`
`Global___GetRobotAPIKeysRequest`
`Global___APIKey`
`Global___GetRobotAPIKeysResponse`
`Global___DeleteRobotPartResponse`
`Global___Fragment`
`Global___FragmentHistoryEntry`
`Global___FragmentRevision`
`Global___FragmentTag`
`Global___FragmentError`
`Global___FragmentUsage`
`Global___FragmentImport`
`Global___ResolvedFragment`
`Global___ListFragmentsRequest`
`Global___ListFragmentsResponse`
`Global___GetFragmentRequest`
`Global___GetFragmentResponse`
`Global___CreateFragmentRequest`
`Global___CreateFragmentResponse`
`Global___UpdateFragmentRequest`
`Global___UpdateFragmentResponse`
`Global___DeleteFragmentRequest`
`Global___DeleteFragmentResponse`
`Global___GetFragmentHistoryRequest`
`Global___GetFragmentHistoryResponse`
`Global___GetFragmentUsageRequest`
`Global___GetFragmentUsageResponse`
`Global___SetFragmentTagRequest`
`Global___SetFragmentTagResponse`
`Global___DeleteFragmentTagRequest`
`Global___DeleteFragmentTagResponse`
`Global___ListRobotsRequest`
`Global___ListRobotsForLocationsRequest`
`Global___ListRobotsForOrgRequest`
`Global___AdditionalFragment`
`Global___ListNestedFragmentsRequest`
`Global___ListNestedFragmentsResponse`
`Global___ListMachineFragmentsRequest`
`Global___ListMachineFragmentsResponse`
`Global___ListMachineSummariesRequest`
`Global___ListMachineSummariesResponse`
`Global___LocationSummary`
`Global___MachineSummary`
`Global___FragmentSummary`
`Global___ViamServerVersion`
`Global___ViamAgentVersion`
`Global___PartSummary`
`Global___ListRobotsResponse`
`Global___ListRobotsForLocationsResponse`
`Global___ListRobotsForOrgResponse`
`Global___NewRobotRequest`
`Global___NewRobotResponse`
`Global___UpdateRobotRequest`
`Global___UpdateRobotResponse`
`Global___DeleteRobotRequest`
`Global___DeleteRobotResponse`
`Global___GetRobotMetadataRequest`
`Global___GetRobotMetadataResponse`
`Global___UpdateRobotMetadataRequest`
`Global___UpdateRobotMetadataResponse`
`Global___MarkPartAsMainRequest`
`Global___MarkPartAsMainResponse`
`Global___MarkPartForRestartRequest`
`Global___MarkPartForRestartResponse`
`Global___CreateRobotPartSecretRequest`
`Global___CreateRobotPartSecretResponse`
`Global___DeleteRobotPartSecretRequest`
`Global___DeleteRobotPartSecretResponse`
`Global___Authorization`
`Global___AddRoleRequest`
`Global___AddRoleResponse`
`Global___RemoveRoleRequest`
`Global___RemoveRoleResponse`
`Global___ChangeRoleRequest`
`Global___ChangeRoleResponse`
`Global___ListAuthorizationsRequest`
`Global___ListAuthorizationsResponse`
`Global___CheckPermissionsRequest`
`Global___AuthorizedPermissions`
`Global___CheckPermissionsResponse`
`Global___ModuleVersion`
`Global___ModuleMetadata`
`Global___MLModelVersion`
`Global___MLModelMetadata`
`Global___MLTrainingVersion`
`Global___MLTrainingMetadata`
`Global___RegistryItem`
`Global___GetRegistryItemRequest`
`Global___GetRegistryItemResponse`
`Global___CreateRegistryItemRequest`
`Global___CreateRegistryItemResponse`
`Global___UpdateRegistryItemRequest`
`Global___UpdateRegistryItemResponse`
`Global___ListRegistryItemsRequest`
`Global___ListRegistryItemsResponse`
`Global___DeleteRegistryItemRequest`
`Global___DeleteRegistryItemResponse`
`Global___RenameRegistryItemRequest`
`Global___RenameRegistryItemResponse`
`Global___TransferRegistryItemRequest`
`Global___TransferRegistryItemResponse`
`Global___CreateModuleRequest`
`Global___CreateModuleResponse`
`Global___UpdateModuleRequest`
`Global___App`
`Global___UpdateModuleResponse`
`Global___UpdateModuleMetadata`
`Global___UpdateMLModelMetadata`
`Global___UpdateMLTrainingMetadata`
`Global___Model`
`Global___ModuleFileInfo`
`Global___UploadModuleFileRequest`
`Global___UploadModuleFileResponse`
`Global___GetModuleRequest`
`Global___GetModuleResponse`
`Global___Module`
`Global___VersionHistory`
`Global___Uploads`
`Global___ListModulesRequest`
`Global___ListModulesResponse`
`Global___GetUserIDByEmailRequest`
`Global___GetUserIDByEmailResponse`
`Global___ListOrganizationsByUserRequest`
`Global___OrgDetails`
`Global___ListOrganizationsByUserResponse`
`Global___SearchOrganizationsRequest`
`Global___SearchOrganizationsResponse`
`Global___CreateKeyRequest`
`Global___CreateKeyResponse`
`Global___DeleteKeyRequest`
`Global___DeleteKeyResponse`
`Global___RenameKeyRequest`
`Global___RenameKeyResponse`
`Global___AuthorizationDetails`
`Global___APIKeyWithAuthorizations`
`Global___ListKeysRequest`
`Global___ListKeysResponse`
`Global___RotateKeyRequest`
`Global___RotateKeyResponse`
`Global___CreateKeyFromExistingKeyAuthorizationsRequest`
`Global___CreateKeyFromExistingKeyAuthorizationsResponse`
`Global___GetAppContentRequest`
`Global___GetAppContentResponse`
`Global___OrganizationSetLogoRequest`
`Global___OrganizationSetLogoResponse`
`Global___OrganizationGetLogoRequest`
`Global___OrganizationGetLogoResponse`
`Global___EnableAuthServiceRequest`
`Global___EnableAuthServiceResponse`
`Global___DisableAuthServiceRequest`
`Global___DisableAuthServiceResponse`
`Global___CreateOAuthAppRequest`
`Global___CreateOAuthAppResponse`
`Global___ReadOAuthAppRequest`
`Global___ReadOAuthAppResponse`
`Global___UpdateOAuthAppRequest`
`Global___UpdateOAuthAppResponse`
`Global___DeleteOAuthAppRequest`
`Global___DeleteOAuthAppResponse`
`Global___ListOAuthAppsRequest`
`Global___ListOAuthAppsResponse`
`Global___OAuthConfig`
`Global___GetAppBrandingRequest`
`Global___TextOverrides`
`Global___GetAppBrandingResponse`
`Global___AppCustomizations`
`Global___MachinePickerCustomizations`

Classes

`OnlineState`
`AuthenticationType`
`FragmentVisibility`
`FragmentErrorType`
`ModuleSourceType`
`ModuleLanguage`
`RegistryItemStatus`
`Visibility`
`AppType`
`ClientAuthentication`
`PKCE`
`URLValidation`
`EnabledGrant`
`Robot`	Abstract base class for protocol messages.
`RobotPart`	Abstract base class for protocol messages.
`RobotPartHistoryEntry`	Abstract base class for protocol messages.
`AuthenticatorInfo`	Abstract base class for protocol messages.
`ListOrganizationsRequest`	Abstract base class for protocol messages.
`Organization`	Abstract base class for protocol messages.
`OrganizationMember`	Abstract base class for protocol messages.
`ListOrganizationsResponse`	Abstract base class for protocol messages.
`OrganizationInvite`	Abstract base class for protocol messages.
`CreateOrganizationRequest`	Abstract base class for protocol messages.
`CreateOrganizationResponse`	Abstract base class for protocol messages.
`GetOrganizationRequest`	Abstract base class for protocol messages.
`GetOrganizationResponse`	Abstract base class for protocol messages.
`GetOrganizationNamespaceAvailabilityRequest`	Abstract base class for protocol messages.
`GetOrganizationNamespaceAvailabilityResponse`	Abstract base class for protocol messages.
`FragmentImportList`	Abstract base class for protocol messages.
`UpdateOrganizationRequest`	Abstract base class for protocol messages.
`UpdateOrganizationResponse`	Abstract base class for protocol messages.
`UpdateOrganizationNamespaceRequest`	Abstract base class for protocol messages.
`UpdateOrganizationNamespaceResponse`	Abstract base class for protocol messages.
`DeleteOrganizationRequest`	Abstract base class for protocol messages.
`DeleteOrganizationResponse`	Abstract base class for protocol messages.
`GetOrganizationMetadataRequest`	Abstract base class for protocol messages.
`GetOrganizationMetadataResponse`	Abstract base class for protocol messages.
`UpdateOrganizationMetadataRequest`	Abstract base class for protocol messages.
`UpdateOrganizationMetadataResponse`	Abstract base class for protocol messages.
`ListOrganizationMembersRequest`	Abstract base class for protocol messages.
`ListOrganizationMembersResponse`	Abstract base class for protocol messages.
`CreateOrganizationInviteRequest`	Abstract base class for protocol messages.
`CreateOrganizationInviteResponse`	Abstract base class for protocol messages.
`UpdateOrganizationInviteAuthorizationsRequest`	Abstract base class for protocol messages.
`UpdateOrganizationInviteAuthorizationsResponse`	Abstract base class for protocol messages.
`DeleteOrganizationInviteRequest`	Abstract base class for protocol messages.
`DeleteOrganizationInviteResponse`	Abstract base class for protocol messages.
`ResendOrganizationInviteRequest`	Abstract base class for protocol messages.
`ResendOrganizationInviteResponse`	Abstract base class for protocol messages.
`DeleteOrganizationMemberRequest`	Abstract base class for protocol messages.
`DeleteOrganizationMemberResponse`	Abstract base class for protocol messages.
`BillingAddress`	Third Party Org Services
`EnableBillingServiceRequest`	Abstract base class for protocol messages.
`EnableBillingServiceResponse`	Abstract base class for protocol messages.
`UpdateBillingServiceRequest`	Abstract base class for protocol messages.
`UpdateBillingServiceResponse`	Abstract base class for protocol messages.
`GetBillingServiceConfigRequest`	Abstract base class for protocol messages.
`GetBillingServiceConfigResponse`	Abstract base class for protocol messages.
`DisableBillingServiceRequest`	Abstract base class for protocol messages.
`DisableBillingServiceResponse`	Abstract base class for protocol messages.
`OrganizationSetSupportEmailRequest`	Abstract base class for protocol messages.
`OrganizationSetSupportEmailResponse`	Abstract base class for protocol messages.
`OrganizationGetSupportEmailRequest`	Abstract base class for protocol messages.
`OrganizationGetSupportEmailResponse`	Abstract base class for protocol messages.
`OrganizationIdentity`	Location
`LocationOrganization`	Abstract base class for protocol messages.
`LocationAuth`	Abstract base class for protocol messages.
`StorageConfig`	Abstract base class for protocol messages.
`Location`	Abstract base class for protocol messages.
`SharedSecret`	SharedSecret is a secret used for LocationAuth and RobotParts.
`CreateLocationRequest`	Abstract base class for protocol messages.
`CreateLocationResponse`	Abstract base class for protocol messages.
`GetLocationRequest`	Abstract base class for protocol messages.
`GetLocationResponse`	Abstract base class for protocol messages.
`UpdateLocationRequest`	Abstract base class for protocol messages.
`UpdateLocationResponse`	Abstract base class for protocol messages.
`DeleteLocationRequest`	Abstract base class for protocol messages.
`DeleteLocationResponse`	Abstract base class for protocol messages.
`GetLocationMetadataRequest`	Abstract base class for protocol messages.
`GetLocationMetadataResponse`	Abstract base class for protocol messages.
`UpdateLocationMetadataRequest`	Abstract base class for protocol messages.
`UpdateLocationMetadataResponse`	Abstract base class for protocol messages.
`GetOrganizationsWithAccessToLocationRequest`	Abstract base class for protocol messages.
`GetOrganizationsWithAccessToLocationResponse`	Abstract base class for protocol messages.
`ListLocationsRequest`	Abstract base class for protocol messages.
`ShareLocationRequest`	Abstract base class for protocol messages.
`ShareLocationResponse`	Abstract base class for protocol messages.
`UnshareLocationRequest`	Abstract base class for protocol messages.
`UnshareLocationResponse`	Abstract base class for protocol messages.
`ListLocationsResponse`	Abstract base class for protocol messages.
`CreateLocationSecretRequest`	Abstract base class for protocol messages.
`CreateLocationSecretResponse`	Abstract base class for protocol messages.
`DeleteLocationSecretRequest`	Abstract base class for protocol messages.
`DeleteLocationSecretResponse`	Abstract base class for protocol messages.
`LocationAuthRequest`	Abstract base class for protocol messages.
`LocationAuthResponse`	Abstract base class for protocol messages.
`GetRobotRequest`	Abstract base class for protocol messages.
`GetRoverRentalRobotsRequest`	Abstract base class for protocol messages.
`RoverRentalRobot`	Abstract base class for protocol messages.
`GetRoverRentalRobotsResponse`	Abstract base class for protocol messages.
`GetRobotResponse`	Abstract base class for protocol messages.
`GetRobotPartsRequest`	Abstract base class for protocol messages.
`GetRobotPartsResponse`	Abstract base class for protocol messages.
`GetRobotPartRequest`	Abstract base class for protocol messages.
`GetRobotPartResponse`	Abstract base class for protocol messages.
`GetRobotPartByNameAndLocationRequest`	Abstract base class for protocol messages.
`GetRobotPartByNameAndLocationResponse`	Abstract base class for protocol messages.
`GetRobotPartLogsRequest`	Abstract base class for protocol messages.
`GetRobotPartLogsResponse`	Abstract base class for protocol messages.
`TailRobotPartLogsRequest`	Abstract base class for protocol messages.
`TailRobotPartLogsResponse`	Abstract base class for protocol messages.
`GetRobotPartHistoryRequest`	Abstract base class for protocol messages.
`GetRobotPartHistoryResponse`	Abstract base class for protocol messages.
`UpdateRobotPartRequest`	Abstract base class for protocol messages.
`UpdateRobotPartResponse`	Abstract base class for protocol messages.
`NewRobotPartRequest`	Abstract base class for protocol messages.
`NewRobotPartResponse`	Abstract base class for protocol messages.
`DeleteRobotPartRequest`	Abstract base class for protocol messages.
`GetRobotPartMetadataRequest`	Abstract base class for protocol messages.
`GetRobotPartMetadataResponse`	Abstract base class for protocol messages.
`UpdateRobotPartMetadataRequest`	Abstract base class for protocol messages.
`UpdateRobotPartMetadataResponse`	Abstract base class for protocol messages.
`GetRobotAPIKeysRequest`	Abstract base class for protocol messages.
`APIKey`	Abstract base class for protocol messages.
`GetRobotAPIKeysResponse`	Abstract base class for protocol messages.
`DeleteRobotPartResponse`	Abstract base class for protocol messages.
`Fragment`	Abstract base class for protocol messages.
`FragmentHistoryEntry`	Abstract base class for protocol messages.
`FragmentRevision`	Abstract base class for protocol messages.
`FragmentTag`	Abstract base class for protocol messages.
`FragmentError`	Abstract base class for protocol messages.
`FragmentUsage`	Cached fragment usage statistics
`FragmentImport`	Abstract base class for protocol messages.
`ResolvedFragment`	Abstract base class for protocol messages.
`ListFragmentsRequest`	Abstract base class for protocol messages.
`ListFragmentsResponse`	Abstract base class for protocol messages.
`GetFragmentRequest`	Abstract base class for protocol messages.
`GetFragmentResponse`	Abstract base class for protocol messages.
`CreateFragmentRequest`	Abstract base class for protocol messages.
`CreateFragmentResponse`	Abstract base class for protocol messages.
`UpdateFragmentRequest`	Abstract base class for protocol messages.
`UpdateFragmentResponse`	Abstract base class for protocol messages.
`DeleteFragmentRequest`	Abstract base class for protocol messages.
`DeleteFragmentResponse`	Abstract base class for protocol messages.
`GetFragmentHistoryRequest`	Abstract base class for protocol messages.
`GetFragmentHistoryResponse`	Abstract base class for protocol messages.
`GetFragmentUsageRequest`	Abstract base class for protocol messages.
`GetFragmentUsageResponse`	Abstract base class for protocol messages.
`SetFragmentTagRequest`	Abstract base class for protocol messages.
`SetFragmentTagResponse`	Abstract base class for protocol messages.
`DeleteFragmentTagRequest`	Abstract base class for protocol messages.
`DeleteFragmentTagResponse`	Abstract base class for protocol messages.
`ListRobotsRequest`	Abstract base class for protocol messages.
`ListRobotsForLocationsRequest`	Abstract base class for protocol messages.
`ListRobotsForOrgRequest`	Abstract base class for protocol messages.
`AdditionalFragment`	Abstract base class for protocol messages.
`ListNestedFragmentsRequest`	Abstract base class for protocol messages.
`ListNestedFragmentsResponse`	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.
`LocationSummary`	Abstract base class for protocol messages.
`MachineSummary`	Abstract base class for protocol messages.
`FragmentSummary`	Abstract base class for protocol messages.
`ViamServerVersion`	Abstract base class for protocol messages.
`ViamAgentVersion`	Abstract base class for protocol messages.
`PartSummary`	Abstract base class for protocol messages.
`ListRobotsResponse`	Abstract base class for protocol messages.
`ListRobotsForLocationsResponse`	Abstract base class for protocol messages.
`ListRobotsForOrgResponse`	Abstract base class for protocol messages.
`NewRobotRequest`	Abstract base class for protocol messages.
`NewRobotResponse`	Abstract base class for protocol messages.
`UpdateRobotRequest`	Abstract base class for protocol messages.
`UpdateRobotResponse`	Abstract base class for protocol messages.
`DeleteRobotRequest`	Abstract base class for protocol messages.
`DeleteRobotResponse`	Abstract base class for protocol messages.
`GetRobotMetadataRequest`	Abstract base class for protocol messages.
`GetRobotMetadataResponse`	Abstract base class for protocol messages.
`UpdateRobotMetadataRequest`	Abstract base class for protocol messages.
`UpdateRobotMetadataResponse`	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.
`CreateRobotPartSecretRequest`	Abstract base class for protocol messages.
`CreateRobotPartSecretResponse`	Abstract base class for protocol messages.
`DeleteRobotPartSecretRequest`	Abstract base class for protocol messages.
`DeleteRobotPartSecretResponse`	Abstract base class for protocol messages.
`Authorization`	Abstract base class for protocol messages.
`AddRoleRequest`	Abstract base class for protocol messages.
`AddRoleResponse`	Abstract base class for protocol messages.
`RemoveRoleRequest`	Abstract base class for protocol messages.
`RemoveRoleResponse`	Abstract base class for protocol messages.
`ChangeRoleRequest`	Abstract base class for protocol messages.
`ChangeRoleResponse`	Abstract base class for protocol messages.
`ListAuthorizationsRequest`	Abstract base class for protocol messages.
`ListAuthorizationsResponse`	Abstract base class for protocol messages.
`CheckPermissionsRequest`	Abstract base class for protocol messages.
`AuthorizedPermissions`	Abstract base class for protocol messages.
`CheckPermissionsResponse`	Abstract base class for protocol messages.
`ModuleVersion`	Abstract base class for protocol messages.
`ModuleMetadata`	Abstract base class for protocol messages.
`MLModelVersion`	Abstract base class for protocol messages.
`MLModelMetadata`	Abstract base class for protocol messages.
`MLTrainingVersion`	Abstract base class for protocol messages.
`MLTrainingMetadata`	Abstract base class for protocol messages.
`RegistryItem`	Abstract base class for protocol messages.
`GetRegistryItemRequest`	Abstract base class for protocol messages.
`GetRegistryItemResponse`	Abstract base class for protocol messages.
`CreateRegistryItemRequest`	Abstract base class for protocol messages.
`CreateRegistryItemResponse`	Abstract base class for protocol messages.
`UpdateRegistryItemRequest`	Abstract base class for protocol messages.
`UpdateRegistryItemResponse`	Abstract base class for protocol messages.
`ListRegistryItemsRequest`	Abstract base class for protocol messages.
`ListRegistryItemsResponse`	Abstract base class for protocol messages.
`DeleteRegistryItemRequest`	Abstract base class for protocol messages.
`DeleteRegistryItemResponse`	Abstract base class for protocol messages.
`RenameRegistryItemRequest`	Abstract base class for protocol messages.
`RenameRegistryItemResponse`	Abstract base class for protocol messages.
`TransferRegistryItemRequest`	Abstract base class for protocol messages.
`TransferRegistryItemResponse`	Abstract base class for protocol messages.
`CreateModuleRequest`	Modules
`CreateModuleResponse`	Abstract base class for protocol messages.
`UpdateModuleRequest`	Abstract base class for protocol messages.
`App`	Abstract base class for protocol messages.
`UpdateModuleResponse`	Abstract base class for protocol messages.
`UpdateModuleMetadata`	Abstract base class for protocol messages.
`UpdateMLModelMetadata`	Abstract base class for protocol messages.
`UpdateMLTrainingMetadata`	Abstract base class for protocol messages.
`Model`	Abstract base class for protocol messages.
`ModuleFileInfo`	Abstract base class for protocol messages.
`UploadModuleFileRequest`	Abstract base class for protocol messages.
`UploadModuleFileResponse`	Abstract base class for protocol messages.
`GetModuleRequest`	Abstract base class for protocol messages.
`GetModuleResponse`	Abstract base class for protocol messages.
`Module`	Abstract base class for protocol messages.
`VersionHistory`	Abstract base class for protocol messages.
`Uploads`	Abstract base class for protocol messages.
`ListModulesRequest`	Abstract base class for protocol messages.
`ListModulesResponse`	Abstract base class for protocol messages.
`GetUserIDByEmailRequest`	Abstract base class for protocol messages.
`GetUserIDByEmailResponse`	Abstract base class for protocol messages.
`ListOrganizationsByUserRequest`	Abstract base class for protocol messages.
`OrgDetails`	Abstract base class for protocol messages.
`ListOrganizationsByUserResponse`	Abstract base class for protocol messages.
`SearchOrganizationsRequest`	Abstract base class for protocol messages.
`SearchOrganizationsResponse`	Abstract base class for protocol messages.
`CreateKeyRequest`	Abstract base class for protocol messages.
`CreateKeyResponse`	Abstract base class for protocol messages.
`DeleteKeyRequest`	Abstract base class for protocol messages.
`DeleteKeyResponse`	Abstract base class for protocol messages.
`RenameKeyRequest`	Abstract base class for protocol messages.
`RenameKeyResponse`	Abstract base class for protocol messages.
`AuthorizationDetails`	Abstract base class for protocol messages.
`APIKeyWithAuthorizations`	Abstract base class for protocol messages.
`ListKeysRequest`	Abstract base class for protocol messages.
`ListKeysResponse`	Abstract base class for protocol messages.
`RotateKeyRequest`	Abstract base class for protocol messages.
`RotateKeyResponse`	Abstract base class for protocol messages.
`CreateKeyFromExistingKeyAuthorizationsRequest`	Abstract base class for protocol messages.
`CreateKeyFromExistingKeyAuthorizationsResponse`	Abstract base class for protocol messages.
`GetAppContentRequest`	Abstract base class for protocol messages.
`GetAppContentResponse`	Abstract base class for protocol messages.
`OrganizationSetLogoRequest`	Abstract base class for protocol messages.
`OrganizationSetLogoResponse`	Abstract base class for protocol messages.
`OrganizationGetLogoRequest`	Abstract base class for protocol messages.
`OrganizationGetLogoResponse`	Abstract base class for protocol messages.
`EnableAuthServiceRequest`	Abstract base class for protocol messages.
`EnableAuthServiceResponse`	Abstract base class for protocol messages.
`DisableAuthServiceRequest`	Abstract base class for protocol messages.
`DisableAuthServiceResponse`	Abstract base class for protocol messages.
`CreateOAuthAppRequest`	Abstract base class for protocol messages.
`CreateOAuthAppResponse`	Abstract base class for protocol messages.
`ReadOAuthAppRequest`	Abstract base class for protocol messages.
`ReadOAuthAppResponse`	Abstract base class for protocol messages.
`UpdateOAuthAppRequest`	Abstract base class for protocol messages.
`UpdateOAuthAppResponse`	Abstract base class for protocol messages.
`DeleteOAuthAppRequest`	Abstract base class for protocol messages.
`DeleteOAuthAppResponse`	Abstract base class for protocol messages.
`ListOAuthAppsRequest`	Abstract base class for protocol messages.
`ListOAuthAppsResponse`	Abstract base class for protocol messages.
`OAuthConfig`	Abstract base class for protocol messages.
`GetAppBrandingRequest`	Branding and customization for app machine picker
`TextOverrides`	Abstract base class for protocol messages.
`GetAppBrandingResponse`	Abstract base class for protocol messages.
`AppCustomizations`	Abstract base class for protocol messages.
`MachinePickerCustomizations`	Abstract base class for protocol messages.

Module Contents

viam.gen.app.v1.app_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.v1.app_pb2.OnlineState: Bases: _OnlineState

viam.gen.app.v1.app_pb2.ONLINE_STATE_UNSPECIFIED: OnlineState

viam.gen.app.v1.app_pb2.ONLINE_STATE_ONLINE: OnlineState

viam.gen.app.v1.app_pb2.ONLINE_STATE_OFFLINE: OnlineState

viam.gen.app.v1.app_pb2.ONLINE_STATE_AWAITING_SETUP: OnlineState

type viam.gen.app.v1.app_pb2.Global___OnlineState = OnlineState

class viam.gen.app.v1.app_pb2.AuthenticationType: Bases: _AuthenticationType

viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_UNSPECIFIED: AuthenticationType

viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_WEB_OAUTH: AuthenticationType

viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_API_KEY: AuthenticationType

viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_ROBOT_PART_SECRET: AuthenticationType

viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_LOCATION_SECRET: AuthenticationType

type viam.gen.app.v1.app_pb2.Global___AuthenticationType = AuthenticationType

class viam.gen.app.v1.app_pb2.FragmentVisibility: Bases: _FragmentVisibility

viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_UNSPECIFIED: FragmentVisibility

viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PRIVATE: FragmentVisibility

viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PUBLIC: FragmentVisibility

viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PUBLIC_UNLISTED: FragmentVisibility

type viam.gen.app.v1.app_pb2.Global___FragmentVisibility = FragmentVisibility

class viam.gen.app.v1.app_pb2.FragmentErrorType: Bases: _FragmentErrorType

viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_UNSPECIFIED: FragmentErrorType

viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_NO_ACCESS: FragmentErrorType

viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_NESTING_LIMIT_EXCEEDED: FragmentErrorType

viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_CHILD_ID_INVALID: FragmentErrorType

viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_CYCLE_DETECTED: FragmentErrorType

type viam.gen.app.v1.app_pb2.Global___FragmentErrorType = FragmentErrorType

class viam.gen.app.v1.app_pb2.ModuleSourceType: Bases: _ModuleSourceType

viam.gen.app.v1.app_pb2.MODULE_SOURCE_TYPE_UNSPECIFIED: ModuleSourceType

viam.gen.app.v1.app_pb2.MODULE_SOURCE_TYPE_EXTERNAL: ModuleSourceType: Module source code is stored externally, such as in github.

viam.gen.app.v1.app_pb2.MODULE_SOURCE_TYPE_VIAM_HOSTED: ModuleSourceType: Module source code is versioned and managed within Viam.

type viam.gen.app.v1.app_pb2.Global___ModuleSourceType = ModuleSourceType

class viam.gen.app.v1.app_pb2.ModuleLanguage: Bases: _ModuleLanguage

viam.gen.app.v1.app_pb2.MODULE_LANGUAGE_UNSPECIFIED: ModuleLanguage

viam.gen.app.v1.app_pb2.MODULE_LANGUAGE_GOLANG: ModuleLanguage

viam.gen.app.v1.app_pb2.MODULE_LANGUAGE_PYTHON: ModuleLanguage

viam.gen.app.v1.app_pb2.MODULE_LANGUAGE_CPP: ModuleLanguage

type viam.gen.app.v1.app_pb2.Global___ModuleLanguage = ModuleLanguage

class viam.gen.app.v1.app_pb2.RegistryItemStatus: Bases: _RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_UNSPECIFIED: RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_PUBLISHED: RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_IN_DEVELOPMENT: RegistryItemStatus

type viam.gen.app.v1.app_pb2.Global___RegistryItemStatus = RegistryItemStatus

class viam.gen.app.v1.app_pb2.Visibility: Bases: _Visibility

viam.gen.app.v1.app_pb2.VISIBILITY_UNSPECIFIED: Visibility

viam.gen.app.v1.app_pb2.VISIBILITY_PRIVATE: Visibility: Private registry items are visible only within the owning org

viam.gen.app.v1.app_pb2.VISIBILITY_PUBLIC: Visibility: Public registry items are visible to everyone

viam.gen.app.v1.app_pb2.VISIBILITY_PUBLIC_UNLISTED: Visibility: Public Unlisted registry items are usable in everyone’s robot but are hidden from the registry page as if they are private

type viam.gen.app.v1.app_pb2.Global___Visibility = Visibility

class viam.gen.app.v1.app_pb2.AppType: Bases: _AppType

viam.gen.app.v1.app_pb2.APP_TYPE_UNSPECIFIED: AppType

viam.gen.app.v1.app_pb2.APP_TYPE_SINGLE_MACHINE: AppType

viam.gen.app.v1.app_pb2.APP_TYPE_MULTI_MACHINE: AppType

type viam.gen.app.v1.app_pb2.Global___AppType = AppType

class viam.gen.app.v1.app_pb2.ClientAuthentication: Bases: _ClientAuthentication

viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_UNSPECIFIED: ClientAuthentication

viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_REQUIRED: ClientAuthentication

viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_NOT_REQUIRED: ClientAuthentication

viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_NOT_REQUIRED_WHEN_USING_PKCE: ClientAuthentication

type viam.gen.app.v1.app_pb2.Global___ClientAuthentication = ClientAuthentication

class viam.gen.app.v1.app_pb2.PKCE: Bases: _PKCE

viam.gen.app.v1.app_pb2.PKCE_UNSPECIFIED: PKCE

viam.gen.app.v1.app_pb2.PKCE_REQUIRED: PKCE

viam.gen.app.v1.app_pb2.PKCE_NOT_REQUIRED: PKCE

viam.gen.app.v1.app_pb2.PKCE_NOT_REQUIRED_WHEN_USING_CLIENT_AUTHENTICATION: PKCE

type viam.gen.app.v1.app_pb2.Global___PKCE = PKCE

class viam.gen.app.v1.app_pb2.URLValidation: Bases: _URLValidation

viam.gen.app.v1.app_pb2.URL_VALIDATION_UNSPECIFIED: URLValidation

viam.gen.app.v1.app_pb2.URL_VALIDATION_EXACT_MATCH: URLValidation

viam.gen.app.v1.app_pb2.URL_VALIDATION_ALLOW_WILDCARDS: URLValidation

type viam.gen.app.v1.app_pb2.Global___URLValidation = URLValidation

class viam.gen.app.v1.app_pb2.EnabledGrant: Bases: _EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_UNSPECIFIED: EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_AUTHORIZATION_CODE: EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_IMPLICIT: EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_PASSWORD: EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_REFRESH_TOKEN: EnabledGrant

viam.gen.app.v1.app_pb2.ENABLED_GRANT_DEVICE_CODE: EnabledGrant

type viam.gen.app.v1.app_pb2.Global___EnabledGrant = EnabledGrant

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___Robot = Robot

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___RobotPart = RobotPart

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___RobotPartHistoryEntry = RobotPartHistoryEntry

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___AuthenticatorInfo = AuthenticatorInfo

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ListOrganizationsRequest = ListOrganizationsRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___Organization = Organization

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationMember = OrganizationMember

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListOrganizationsResponse = ListOrganizationsResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___OrganizationInvite = OrganizationInvite

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateOrganizationRequest = CreateOrganizationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateOrganizationResponse = CreateOrganizationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetOrganizationRequest = GetOrganizationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetOrganizationResponse = GetOrganizationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetOrganizationNamespaceAvailabilityRequest = GetOrganizationNamespaceAvailabilityRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetOrganizationNamespaceAvailabilityResponse = GetOrganizationNamespaceAvailabilityResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___FragmentImportList = FragmentImportList

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationRequest = UpdateOrganizationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationResponse = UpdateOrganizationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationNamespaceRequest = UpdateOrganizationNamespaceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationNamespaceResponse = UpdateOrganizationNamespaceResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationRequest = DeleteOrganizationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationResponse = DeleteOrganizationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetOrganizationMetadataRequest = GetOrganizationMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetOrganizationMetadataResponse = GetOrganizationMetadataResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationMetadataRequest = UpdateOrganizationMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationMetadataResponse = UpdateOrganizationMetadataResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListOrganizationMembersRequest = ListOrganizationMembersRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListOrganizationMembersResponse = ListOrganizationMembersResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateOrganizationInviteRequest = CreateOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateOrganizationInviteResponse = CreateOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationInviteAuthorizationsRequest = UpdateOrganizationInviteAuthorizationsRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOrganizationInviteAuthorizationsResponse = UpdateOrganizationInviteAuthorizationsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationInviteRequest = DeleteOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationInviteResponse = DeleteOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ResendOrganizationInviteRequest = ResendOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ResendOrganizationInviteResponse = ResendOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationMemberRequest = DeleteOrganizationMemberRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteOrganizationMemberResponse = DeleteOrganizationMemberResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___BillingAddress = BillingAddress

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___EnableBillingServiceRequest = EnableBillingServiceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___EnableBillingServiceResponse = EnableBillingServiceResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateBillingServiceRequest = UpdateBillingServiceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateBillingServiceResponse = UpdateBillingServiceResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetBillingServiceConfigRequest = GetBillingServiceConfigRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetBillingServiceConfigResponse = GetBillingServiceConfigResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DisableBillingServiceRequest = DisableBillingServiceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DisableBillingServiceResponse = DisableBillingServiceResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationSetSupportEmailRequest = OrganizationSetSupportEmailRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___OrganizationSetSupportEmailResponse = OrganizationSetSupportEmailResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationGetSupportEmailRequest = OrganizationGetSupportEmailRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationGetSupportEmailResponse = OrganizationGetSupportEmailResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___OrganizationIdentity = OrganizationIdentity

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___LocationOrganization = LocationOrganization

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___LocationAuth = LocationAuth

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___StorageConfig = StorageConfig

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___Location = Location

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___SharedSecret = SharedSecret

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateLocationRequest = CreateLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateLocationResponse = CreateLocationResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetLocationRequest = GetLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetLocationResponse = GetLocationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateLocationRequest = UpdateLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateLocationResponse = UpdateLocationResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteLocationRequest = DeleteLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteLocationResponse = DeleteLocationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetLocationMetadataRequest = GetLocationMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetLocationMetadataResponse = GetLocationMetadataResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateLocationMetadataRequest = UpdateLocationMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateLocationMetadataResponse = UpdateLocationMetadataResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetOrganizationsWithAccessToLocationRequest = GetOrganizationsWithAccessToLocationRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetOrganizationsWithAccessToLocationResponse = GetOrganizationsWithAccessToLocationResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ListLocationsRequest = ListLocationsRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ShareLocationRequest = ShareLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ShareLocationResponse = ShareLocationResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UnshareLocationRequest = UnshareLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UnshareLocationResponse = UnshareLocationResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListLocationsResponse = ListLocationsResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateLocationSecretRequest = CreateLocationSecretRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateLocationSecretResponse = CreateLocationSecretResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteLocationSecretRequest = DeleteLocationSecretRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteLocationSecretResponse = DeleteLocationSecretResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___LocationAuthRequest = LocationAuthRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___LocationAuthResponse = LocationAuthResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotRequest = GetRobotRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRoverRentalRobotsRequest = GetRoverRentalRobotsRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RoverRentalRobot = RoverRentalRobot

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetRoverRentalRobotsResponse = GetRoverRentalRobotsResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRobotResponse = GetRobotResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartsRequest = GetRobotPartsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetRobotPartsResponse = GetRobotPartsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartRequest = GetRobotPartRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRobotPartResponse = GetRobotPartResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartByNameAndLocationRequest = GetRobotPartByNameAndLocationRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRobotPartByNameAndLocationResponse = GetRobotPartByNameAndLocationResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartLogsRequest = GetRobotPartLogsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetRobotPartLogsResponse = GetRobotPartLogsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___TailRobotPartLogsRequest = TailRobotPartLogsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___TailRobotPartLogsResponse = TailRobotPartLogsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartHistoryRequest = GetRobotPartHistoryRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetRobotPartHistoryResponse = GetRobotPartHistoryResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateRobotPartRequest = UpdateRobotPartRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotPartResponse = UpdateRobotPartResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___NewRobotPartRequest = NewRobotPartRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___NewRobotPartResponse = NewRobotPartResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteRobotPartRequest = DeleteRobotPartRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotPartMetadataRequest = GetRobotPartMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRobotPartMetadataResponse = GetRobotPartMetadataResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotPartMetadataRequest = UpdateRobotPartMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotPartMetadataResponse = UpdateRobotPartMetadataResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotAPIKeysRequest = GetRobotAPIKeysRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___APIKey = APIKey

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetRobotAPIKeysResponse = GetRobotAPIKeysResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteRobotPartResponse = DeleteRobotPartResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___Fragment = Fragment

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___FragmentHistoryEntry = FragmentHistoryEntry

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___FragmentRevision = FragmentRevision

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___FragmentTag = FragmentTag

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___FragmentError = FragmentError

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___FragmentUsage = FragmentUsage

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___FragmentImport = FragmentImport

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ResolvedFragment = ResolvedFragment

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListFragmentsRequest = ListFragmentsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListFragmentsResponse = ListFragmentsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetFragmentRequest = GetFragmentRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetFragmentResponse = GetFragmentResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateFragmentRequest = CreateFragmentRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateFragmentResponse = CreateFragmentResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateFragmentRequest = UpdateFragmentRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateFragmentResponse = UpdateFragmentResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteFragmentRequest = DeleteFragmentRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteFragmentResponse = DeleteFragmentResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetFragmentHistoryRequest = GetFragmentHistoryRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetFragmentHistoryResponse = GetFragmentHistoryResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetFragmentUsageRequest = GetFragmentUsageRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___GetFragmentUsageResponse = GetFragmentUsageResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___SetFragmentTagRequest = SetFragmentTagRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___SetFragmentTagResponse = SetFragmentTagResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteFragmentTagRequest = DeleteFragmentTagRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___DeleteFragmentTagResponse = DeleteFragmentTagResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListRobotsRequest = ListRobotsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListRobotsForLocationsRequest = ListRobotsForLocationsRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListRobotsForOrgRequest = ListRobotsForOrgRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___AdditionalFragment = AdditionalFragment

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListNestedFragmentsRequest = ListNestedFragmentsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListNestedFragmentsResponse = ListNestedFragmentsResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ListMachineFragmentsRequest = ListMachineFragmentsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListMachineFragmentsResponse = ListMachineFragmentsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListMachineSummariesRequest = ListMachineSummariesRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListMachineSummariesResponse = ListMachineSummariesResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___LocationSummary = LocationSummary

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___MachineSummary = MachineSummary

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___FragmentSummary = FragmentSummary

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ViamServerVersion = ViamServerVersion

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ViamAgentVersion = ViamAgentVersion

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___PartSummary = PartSummary

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListRobotsResponse = ListRobotsResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListRobotsForLocationsResponse = ListRobotsForLocationsResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListRobotsForOrgResponse = ListRobotsForOrgResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___NewRobotRequest = NewRobotRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___NewRobotResponse = NewRobotResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateRobotRequest = UpdateRobotRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotResponse = UpdateRobotResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteRobotRequest = DeleteRobotRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteRobotResponse = DeleteRobotResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRobotMetadataRequest = GetRobotMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRobotMetadataResponse = GetRobotMetadataResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotMetadataRequest = UpdateRobotMetadataRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRobotMetadataResponse = UpdateRobotMetadataResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___MarkPartAsMainRequest = MarkPartAsMainRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___MarkPartAsMainResponse = MarkPartAsMainResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___MarkPartForRestartRequest = MarkPartForRestartRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___MarkPartForRestartResponse = MarkPartForRestartResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateRobotPartSecretRequest = CreateRobotPartSecretRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateRobotPartSecretResponse = CreateRobotPartSecretResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteRobotPartSecretRequest = DeleteRobotPartSecretRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteRobotPartSecretResponse = DeleteRobotPartSecretResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___Authorization = Authorization

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___AddRoleRequest = AddRoleRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___AddRoleResponse = AddRoleResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___RemoveRoleRequest = RemoveRoleRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___RemoveRoleResponse = RemoveRoleResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ChangeRoleRequest = ChangeRoleRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ChangeRoleResponse = ChangeRoleResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListAuthorizationsRequest = ListAuthorizationsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListAuthorizationsResponse = ListAuthorizationsResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___CheckPermissionsRequest = CheckPermissionsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___AuthorizedPermissions = AuthorizedPermissions

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___CheckPermissionsResponse = CheckPermissionsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ModuleVersion = ModuleVersion

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ModuleMetadata = ModuleMetadata

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___MLModelVersion = MLModelVersion

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___MLModelMetadata = MLModelMetadata

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___MLTrainingVersion = MLTrainingVersion

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___MLTrainingMetadata = MLTrainingMetadata

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RegistryItem = RegistryItem

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetRegistryItemRequest = GetRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetRegistryItemResponse = GetRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateRegistryItemRequest = CreateRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateRegistryItemResponse = CreateRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateRegistryItemRequest = UpdateRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateRegistryItemResponse = UpdateRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListRegistryItemsRequest = ListRegistryItemsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListRegistryItemsResponse = ListRegistryItemsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteRegistryItemRequest = DeleteRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteRegistryItemResponse = DeleteRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RenameRegistryItemRequest = RenameRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___RenameRegistryItemResponse = RenameRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___TransferRegistryItemRequest = TransferRegistryItemRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___TransferRegistryItemResponse = TransferRegistryItemResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateModuleRequest = CreateModuleRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateModuleResponse = CreateModuleResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateModuleRequest = UpdateModuleRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___App = App

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateModuleResponse = UpdateModuleResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateModuleMetadata = UpdateModuleMetadata

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateMLModelMetadata = UpdateMLModelMetadata

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UpdateMLTrainingMetadata = UpdateMLTrainingMetadata

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___Model = Model

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ModuleFileInfo = ModuleFileInfo

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UploadModuleFileRequest = UploadModuleFileRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___UploadModuleFileResponse = UploadModuleFileResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetModuleRequest = GetModuleRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___GetModuleResponse = GetModuleResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___Module = Module

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___VersionHistory = VersionHistory

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___Uploads = Uploads

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListModulesRequest = ListModulesRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ListModulesResponse = ListModulesResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetUserIDByEmailRequest = GetUserIDByEmailRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetUserIDByEmailResponse = GetUserIDByEmailResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListOrganizationsByUserRequest = ListOrganizationsByUserRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrgDetails = OrgDetails

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListOrganizationsByUserResponse = ListOrganizationsByUserResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___SearchOrganizationsRequest = SearchOrganizationsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___SearchOrganizationsResponse = SearchOrganizationsResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___CreateKeyRequest = CreateKeyRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateKeyResponse = CreateKeyResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteKeyRequest = DeleteKeyRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteKeyResponse = DeleteKeyResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RenameKeyRequest = RenameKeyRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RenameKeyResponse = RenameKeyResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___AuthorizationDetails = AuthorizationDetails

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___APIKeyWithAuthorizations = APIKeyWithAuthorizations

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListKeysRequest = ListKeysRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListKeysResponse = ListKeysResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RotateKeyRequest = RotateKeyRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___RotateKeyResponse = RotateKeyResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateKeyFromExistingKeyAuthorizationsRequest = CreateKeyFromExistingKeyAuthorizationsRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateKeyFromExistingKeyAuthorizationsResponse = CreateKeyFromExistingKeyAuthorizationsResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetAppContentRequest = GetAppContentRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetAppContentResponse = GetAppContentResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationSetLogoRequest = OrganizationSetLogoRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___OrganizationSetLogoResponse = OrganizationSetLogoResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationGetLogoRequest = OrganizationGetLogoRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___OrganizationGetLogoResponse = OrganizationGetLogoResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___EnableAuthServiceRequest = EnableAuthServiceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___EnableAuthServiceResponse = EnableAuthServiceResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DisableAuthServiceRequest = DisableAuthServiceRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DisableAuthServiceResponse = DisableAuthServiceResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___CreateOAuthAppRequest = CreateOAuthAppRequest

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___CreateOAuthAppResponse = CreateOAuthAppResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ReadOAuthAppRequest = ReadOAuthAppRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___ReadOAuthAppResponse = ReadOAuthAppResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOAuthAppRequest = UpdateOAuthAppRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___UpdateOAuthAppResponse = UpdateOAuthAppResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___DeleteOAuthAppRequest = DeleteOAuthAppRequest

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___DeleteOAuthAppResponse = DeleteOAuthAppResponse

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___ListOAuthAppsRequest = ListOAuthAppsRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___ListOAuthAppsResponse = ListOAuthAppsResponse

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___OAuthConfig = OAuthConfig

class viam.gen.app.v1.app_pb2.GetAppBrandingRequest(*, public_namespace: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Branding and customization for app machine picker

public_namespace: str

name: str

type viam.gen.app.v1.app_pb2.Global___GetAppBrandingRequest = GetAppBrandingRequest

class viam.gen.app.v1.app_pb2.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]

type viam.gen.app.v1.app_pb2.Global___TextOverrides = TextOverrides

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___GetAppBrandingResponse = GetAppBrandingResponse

class viam.gen.app.v1.app_pb2.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.

type viam.gen.app.v1.app_pb2.Global___AppCustomizations = AppCustomizations

class viam.gen.app.v1.app_pb2.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

type viam.gen.app.v1.app_pb2.Global___MachinePickerCustomizations = MachinePickerCustomizations